Command

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> com >> maddyhome >> idea >> vim >> [ command overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of com.maddyhome.idea.vim.command.Command

SOURCE |

Download com.maddyhome.idea.vim.command.Command

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.maddyhome.idea.vim.command
Class Command

java.lang.Object
  com.maddyhome.idea.vim.command.Command

public class Command
extends java.lang.Object

This represents a single Vim command to be executed. It may optionally include an argument if appropriate for the command. The command has a count and a type.

Field Summary

private AnAction action


private Argument argument


static int CHANGE
          Represents commands that change text in the editor

static int COPY
          Represents commands that copy text in the editor

private int count


static int DELETE
          Represents commands that remove text from the editor

static int FLAG_CLEAR_STROKES
          This insert command should clear all saved keystrokes from the current insert

static int FLAG_EXPECT_MORE
          This command should be followed by another command

static int FLAG_MOT_CHARACTERWISE


static int FLAG_MOT_EXCLUSIVE


static int FLAG_MOT_INCLUSIVE


static int FLAG_MOT_LINEWISE
          Motion flags

static int FLAG_MULTIKEY_UNDO
          This command starts a multi-command undo transaction

static int FLAG_NO_ARG_RECORDING
          This flag indicates the command's argument isn't used while recording

static int FLAG_NO_REPEAT
          Special command flag that indicates it is not to be repeated

static int FLAG_OP_PEND
          Special flag used for any mappings involving operators

static int FLAG_SAVE_JUMP
          Indicates that the cursor position should be saved prior to this motion command

static int FLAG_SAVE_STROKE
          This keystroke should be saved as part of the current insert

static int FLAG_SEARCH_FWD
          Search Flags

static int FLAG_SEARCH_REV


private int flags


static int INSERT
          Represents commands that insert new text into the editor

private java.util.List keys


static int MOTION
          Represents commands that actually move the cursor and can be arguments to operators

static int OTHER_READONLY
          Represents other types of commands

static int OTHER_WRITABLE


static int PASTE
          Represents commands that paste text into the editor

static int RESET


static int SELECT_REGISTER
          Represents commands that select the register

private int type


Constructor Summary

Command(int count, AnAction action, int type, int flags)
          Creates a command that doesn't require an argument

Command(int count, AnAction action, int type, int flags, Argument arg)
          Creates a command that requires an argument

Method Summary

AnAction getAction()
          Gets the action to execute when the command is run

Argument getArgument()
          Gets the command's argument, if any.

int getCount()
          Returns the command count.

int getFlags()
          Gets the flags associated with the command

java.util.List getKeys()


int getRawCount()
          Gets to actual count entered by the user, including zero if no count was specified.

int getType()
          Gets the command type

static boolean isReadOnlyType(int type)


void setAction(AnAction action)
          Sets a new action for the command

void setArgument(Argument argument)
          Sets the command's argument to the new value

void setCount(int count)
          Updates the command count to the new value

void setFlags(int flags)
          Sets new flags for the command

void setKeys(java.util.List keys)


Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

FLAG_MOT_LINEWISE

public static final int FLAG_MOT_LINEWISE

Motion flags

See Also:: Constant Field Values

FLAG_MOT_CHARACTERWISE

public static final int FLAG_MOT_CHARACTERWISE

See Also:: Constant Field Values

FLAG_MOT_INCLUSIVE

public static final int FLAG_MOT_INCLUSIVE

See Also:: Constant Field Values

FLAG_MOT_EXCLUSIVE

public static final int FLAG_MOT_EXCLUSIVE

See Also:: Constant Field Values

FLAG_SAVE_JUMP

public static final int FLAG_SAVE_JUMP

Indicates that the cursor position should be saved prior to this motion command

See Also:: Constant Field Values

FLAG_NO_REPEAT

public static final int FLAG_NO_REPEAT

Special command flag that indicates it is not to be repeated

See Also:: Constant Field Values

FLAG_CLEAR_STROKES

public static final int FLAG_CLEAR_STROKES

This insert command should clear all saved keystrokes from the current insert

See Also:: Constant Field Values

FLAG_SAVE_STROKE

public static final int FLAG_SAVE_STROKE

This keystroke should be saved as part of the current insert

See Also:: Constant Field Values

FLAG_SEARCH_FWD

public static final int FLAG_SEARCH_FWD

Search Flags

See Also:: Constant Field Values

FLAG_SEARCH_REV

public static final int FLAG_SEARCH_REV

See Also:: Constant Field Values

FLAG_OP_PEND

public static final int FLAG_OP_PEND

Special flag used for any mappings involving operators

See Also:: Constant Field Values

FLAG_MULTIKEY_UNDO

public static final int FLAG_MULTIKEY_UNDO

This command starts a multi-command undo transaction

See Also:: Constant Field Values

FLAG_EXPECT_MORE

public static final int FLAG_EXPECT_MORE

This command should be followed by another command

See Also:: Constant Field Values

FLAG_NO_ARG_RECORDING

public static final int FLAG_NO_ARG_RECORDING

This flag indicates the command's argument isn't used while recording

See Also:: Constant Field Values

MOTION

public static final int MOTION

Represents commands that actually move the cursor and can be arguments to operators

See Also:: Constant Field Values

INSERT

public static final int INSERT

Represents commands that insert new text into the editor

See Also:: Constant Field Values

DELETE

public static final int DELETE

Represents commands that remove text from the editor

See Also:: Constant Field Values

CHANGE

public static final int CHANGE

Represents commands that change text in the editor

See Also:: Constant Field Values

COPY

public static final int COPY

Represents commands that copy text in the editor

See Also:: Constant Field Values

PASTE

public static final int PASTE

Represents commands that paste text into the editor

See Also:: Constant Field Values

RESET

public static final int RESET

See Also:: Constant Field Values

SELECT_REGISTER

public static final int SELECT_REGISTER

Represents commands that select the register

See Also:: Constant Field Values

OTHER_READONLY

public static final int OTHER_READONLY

Represents other types of commands

See Also:: Constant Field Values

OTHER_WRITABLE

public static final int OTHER_WRITABLE

See Also:: Constant Field Values

count

private int count

action

private AnAction action

type

private int type

flags

private int flags

argument

private Argument argument

keys

private java.util.List keys

Constructor Detail

Command

public Command(int count,
               AnAction action,
               int type,
               int flags)

Creates a command that doesn't require an argument

Command

public Command(int count,
               AnAction action,
               int type,
               int flags,
               Argument arg)

Creates a command that requires an argument

Method Detail

isReadOnlyType

public static boolean isReadOnlyType(int type)

getCount

public int getCount()

Returns the command count. A zero count is returned as one since that is the default for most commands

setCount

public void setCount(int count)

Updates the command count to the new value

getRawCount

public int getRawCount()

Gets to actual count entered by the user, including zero if no count was specified. Some commands need to know whether an actual count was specified or not.

getType

public int getType()

Gets the command type

getFlags

public int getFlags()

Gets the flags associated with the command

setFlags

public void setFlags(int flags)

Sets new flags for the command

getAction

public AnAction getAction()

Gets the action to execute when the command is run

setAction

public void setAction(AnAction action)

Sets a new action for the command

getArgument

public Argument getArgument()

Gets the command's argument, if any.

setArgument

public void setArgument(Argument argument)

Sets the command's argument to the new value

getKeys

public java.util.List getKeys()

setKeys

public void setKeys(java.util.List keys)

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> com >> maddyhome >> idea >> vim >> [ command overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

SOURCE |

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

Field Summary
`private AnAction`	`action`
`private Argument`	`argument`
`static int`	`CHANGE` Represents commands that change text in the editor
`static int`	`COPY` Represents commands that copy text in the editor
`private int`	`count`
`static int`	`DELETE` Represents commands that remove text from the editor
`static int`	`FLAG_CLEAR_STROKES` This insert command should clear all saved keystrokes from the current insert
`static int`	`FLAG_EXPECT_MORE` This command should be followed by another command
`static int`	`FLAG_MOT_CHARACTERWISE`
`static int`	`FLAG_MOT_EXCLUSIVE`
`static int`	`FLAG_MOT_INCLUSIVE`
`static int`	`FLAG_MOT_LINEWISE` Motion flags
`static int`	`FLAG_MULTIKEY_UNDO` This command starts a multi-command undo transaction
`static int`	`FLAG_NO_ARG_RECORDING` This flag indicates the command's argument isn't used while recording
`static int`	`FLAG_NO_REPEAT` Special command flag that indicates it is not to be repeated
`static int`	`FLAG_OP_PEND` Special flag used for any mappings involving operators
`static int`	`FLAG_SAVE_JUMP` Indicates that the cursor position should be saved prior to this motion command
`static int`	`FLAG_SAVE_STROKE` This keystroke should be saved as part of the current insert
`static int`	`FLAG_SEARCH_FWD` Search Flags
`static int`	`FLAG_SEARCH_REV`
`private int`	`flags`
`static int`	`INSERT` Represents commands that insert new text into the editor
`private java.util.List`	`keys`
`static int`	`MOTION` Represents commands that actually move the cursor and can be arguments to operators
`static int`	`OTHER_READONLY` Represents other types of commands
`static int`	`OTHER_WRITABLE`
`static int`	`PASTE` Represents commands that paste text into the editor
`static int`	`RESET`
`static int`	`SELECT_REGISTER` Represents commands that select the register
`private int`	`type`

Constructor Summary
`Command(int count, AnAction action, int type, int flags)` Creates a command that doesn't require an argument
`Command(int count, AnAction action, int type, int flags, Argument arg)` Creates a command that requires an argument

Method Summary
`AnAction`	`getAction()` Gets the action to execute when the command is run
`Argument`	`getArgument()` Gets the command's argument, if any.
`int`	`getCount()` Returns the command count.
`int`	`getFlags()` Gets the flags associated with the command
`java.util.List`	`getKeys()`
`int`	`getRawCount()` Gets to actual count entered by the user, including zero if no count was specified.
`int`	`getType()` Gets the command type
`static boolean`	`isReadOnlyType(int type)`
`void`	`setAction(AnAction action)` Sets a new action for the command
`void`	`setArgument(Argument argument)` Sets the command's argument to the new value
`void`	`setCount(int count)` Updates the command count to the new value
`void`	`setFlags(int flags)` Sets new flags for the command
`void`	`setKeys(java.util.List keys)`

com.maddyhome.idea.vim.command Class Command

FLAG_MOT_LINEWISE

FLAG_MOT_CHARACTERWISE

FLAG_MOT_INCLUSIVE

FLAG_MOT_EXCLUSIVE

FLAG_SAVE_JUMP

FLAG_NO_REPEAT

FLAG_CLEAR_STROKES

FLAG_SAVE_STROKE

FLAG_SEARCH_FWD

FLAG_SEARCH_REV

FLAG_OP_PEND

FLAG_MULTIKEY_UNDO

FLAG_EXPECT_MORE

FLAG_NO_ARG_RECORDING

MOTION

INSERT

DELETE

CHANGE

COPY

PASTE

RESET

SELECT_REGISTER

OTHER_READONLY

OTHER_WRITABLE

count

action

type

flags

argument

keys

Command

Command

isReadOnlyType

getCount

setCount

getRawCount

getType

getFlags

setFlags

getAction

setAction

getArgument

setArgument

getKeys

setKeys

com.maddyhome.idea.vim.command
Class Command