edu.ycp.cs.dh.acegwt.client.ace

Class AceCommandDescription

java.lang.Object

edu.ycp.cs.dh.acegwt.client.ace.AceCommandDescription

public class AceCommandDescription
extends java.lang.Object

Rules describing how editor runs this command (from keyboard, from command line or by AceEditor.execCommand(String) API calls).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AceCommandDescription.ExecAction Ace command execution action.
static class	AceCommandDescription.KeyBinding Key binding description.
static class	AceCommandDescription.MultiSelectAction Action defines a way of running commands based on editor text selection.
static class	AceCommandDescription.ScrollIntoView Ace command scrolling options.

Constructor Summary

Constructors

Constructor and Description
AceCommandDescription(java.lang.String name, AceCommandDescription.ExecAction exec) Define Ace command with command line name and execution action

Method Summary

Modifier and Type	Method and Description
static AceCommandDescription	fromJavaScript(com.google.gwt.core.client.JavaScriptObject obj) Create Ace command from javascript object.
java.lang.String	getAceCommandGroup() Give Ace command group name of this command.
AceCommandDescription.KeyBinding	getBindKey() Give key bindings.
AceCommandDescription.ExecAction	getExec() Give execution action of this command.
AceCommandDescription.MultiSelectAction	getMultiSelectAction() Give multi-select action for this command.
java.lang.String	getName() Give command line name.
AceCommandDescription.ScrollIntoView	getScrollIntoView() Give scroll settings for this command.
boolean	isPassEvent() In case this parameter is true keyboard event will be passed to original listener.
boolean	isReadOnly() Describe does this command change editor document or not.
com.google.gwt.core.client.JavaScriptObject	toJavaScript(AceEditor editor) Create javascript object from Ace command description.
java.lang.String	toString()
AceCommandDescription	withAceCommandGroup(java.lang.String aceCommandGroup) Chainable setter method for aceCommandGroup property.
AceCommandDescription	withBindKey(AceCommandDescription.KeyBinding bindKey) Chainable setter method for bindKey property.
AceCommandDescription	withBindKey(java.lang.String bindKeyForAllPlatforms) Chainable setter method for bindKey property for all platforms.
AceCommandDescription	withBindKey(java.lang.String bindKeyForAllPlatformsExceptMac, java.lang.String bindKeyForMac) Chainable setter method for bindKey property for Mac and other platforms separately.
AceCommandDescription	withMultiSelectAction(AceCommandDescription.MultiSelectAction multiSelectAction) Chainable setter method for multiSelectAction property.
AceCommandDescription	withPassEvent(boolean passEvent) Chainable setter method for passEvent property.
AceCommandDescription	withReadOnly(boolean readOnly) Chainable setter method for readOnly property.
AceCommandDescription	withScrollIntoView(AceCommandDescription.ScrollIntoView scrollIntoView) Chainable setter method for scrollIntoView property.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AceCommandDescription

public AceCommandDescription(java.lang.String name,
                             AceCommandDescription.ExecAction exec)

Define Ace command with command line name and execution action

Parameters:

name - command line name

exec - execution action

Method Detail

getName

public java.lang.String getName()

Give command line name.

Returns:

command line name

getExec

public AceCommandDescription.ExecAction getExec()

Give execution action of this command.

Returns:

execution action

getBindKey

public AceCommandDescription.KeyBinding getBindKey()

Give key bindings.

Returns:

key bindings

isReadOnly

public boolean isReadOnly()

Describe does this command change editor document or not.

Returns:

whether or not editor document could be changed

isPassEvent

public boolean isPassEvent()

In case this parameter is true keyboard event will be passed to original listener.

Returns:

true in case event shouldn't be stopped after command execution

getScrollIntoView

public AceCommandDescription.ScrollIntoView getScrollIntoView()

Give scroll settings for this command. In case it's null command is executed without scroll adjustment. Otherwise see AceCommandDescription.ScrollIntoView for details.

Returns:

scroll settings

getMultiSelectAction

public AceCommandDescription.MultiSelectAction getMultiSelectAction()

Give multi-select action for this command. In case it's null command is executed once without virtual changes in selection ranges. Otherwise see AceCommandDescription.MultiSelectAction for details.

Returns:

multi-select action

getAceCommandGroup

public java.lang.String getAceCommandGroup()

Give Ace command group name of this command.

Returns:

Ace command group name

withBindKey

public AceCommandDescription withBindKey(AceCommandDescription.KeyBinding bindKey)

Chainable setter method for bindKey property.

Parameters:

bindKey - key binding (e.g. "shift-esc|ctrl-`" or "Command+Alt+C")

Returns:

reference to this command description

withBindKey

public AceCommandDescription withBindKey(java.lang.String bindKeyForAllPlatforms)

Chainable setter method for bindKey property for all platforms.

Parameters:

bindKeyForAllPlatforms - key binding (e.g. "shift-esc|ctrl-`" or "Command+Alt+C")

Returns:

reference to this command description

withBindKey

public AceCommandDescription withBindKey(java.lang.String bindKeyForAllPlatformsExceptMac,
                                         java.lang.String bindKeyForMac)

Chainable setter method for bindKey property for Mac and other platforms separately.

Parameters:

bindKeyForAllPlatformsExceptMac - key binding for everything except Mac (e.g. "shift-esc|ctrl-`")

bindKeyForMac - key binding for Mac (e.g. "shift-esc|ctrl-`" or "Command+Alt+C")

Returns:

reference to this command description

withReadOnly

public AceCommandDescription withReadOnly(boolean readOnly)

Chainable setter method for readOnly property.

Parameters:

readOnly - describes does this command change editor document or not

Returns:

reference to this command description

withPassEvent

public AceCommandDescription withPassEvent(boolean passEvent)

Chainable setter method for passEvent property.

Parameters:

passEvent - in case it's true keyboard event will not be stopped and will be passed to original listener after command execution

Returns:

reference to this command description

withScrollIntoView

public AceCommandDescription withScrollIntoView(AceCommandDescription.ScrollIntoView scrollIntoView)

Chainable setter method for scrollIntoView property.

Parameters:

scrollIntoView - scroll settings for this command (in case it's null command is executed without scroll adjustment; otherwise see AceCommandDescription.ScrollIntoView for details)

Returns:

reference to this command description

withMultiSelectAction

public AceCommandDescription withMultiSelectAction(AceCommandDescription.MultiSelectAction multiSelectAction)

Chainable setter method for multiSelectAction property.

Parameters:

multiSelectAction - multi-select action for this command (in case it's null command is executed once without virtual changes in selection ranges; otherwise see AceCommandDescription.MultiSelectAction for details)

Returns:

reference to this command description

withAceCommandGroup

public AceCommandDescription withAceCommandGroup(java.lang.String aceCommandGroup)

Chainable setter method for aceCommandGroup property.

Parameters:

aceCommandGroup - Ace command group name of this command

Returns:

reference to this command description

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

fromJavaScript

public static AceCommandDescription fromJavaScript(com.google.gwt.core.client.JavaScriptObject obj)

Create Ace command from javascript object.

Parameters:

obj - javascript object describing Ace command

Returns:

Ace command description object

toJavaScript

public com.google.gwt.core.client.JavaScriptObject toJavaScript(AceEditor editor)

Create javascript object from Ace command description.

Parameters:

editor - Ace editor java wrapper

Returns:

Ace command javascript object