Package com.levigo.jadice.web.client.commands

Class CreateAnnotationCommand

java.lang.Object

com.levigo.jadice.web.client.util.command.InjectedCommand

com.levigo.jadice.web.client.commands.AbstractContextCommand

com.levigo.jadice.web.client.commands.AbstractPageViewCommand

com.levigo.jadice.web.client.commands.AbstractMouseCommand

com.levigo.jadice.web.client.commands.AbstractDocumentCommand

com.levigo.jadice.web.client.commands.CreateAnnotationCommand

All Implemented Interfaces:

Command, com.levigo.jadice.web.client.util.internal.HasDebugId

public class CreateAnnotationCommand
extends AbstractDocumentCommand
implements com.levigo.jadice.web.client.util.internal.HasDebugId

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	CreateAnnotationCommand.CreateMode

Nested classes/interfaces inherited from class com.levigo.jadice.web.client.commands.AbstractDocumentCommand

AbstractDocumentCommand.Scope

Constructor Summary

Constructors

Constructor	Description
CreateAnnotationCommand()

Method Summary

Modifier and Type	Method	Description
protected boolean	canExecute()	Checks if this command can be executed.
protected void	execute()	This method is called in order to execute the command.
CreateAnnotationCommand.CreateMode	getCreateMode()
String	getDebugId()
String	getID()	The ID of the command.
protected boolean	isSelected()	Returns the selected state of this command.
void	setAnnotationFactory(AnnotationProfile profile, AnnotationFactory factory)
void	setCreateMode(CreateAnnotationCommand.CreateMode createMode)
void	setEditorHost(AbstractBar editorHost)	Sets the context toolbar for the annotation tool.
void	setMouseEvent(com.google.gwt.event.dom.client.MouseEvent<?> mouseEvent)

Methods inherited from class com.levigo.jadice.web.client.commands.AbstractDocumentCommand

getDocument, getRenderControls, getScope, setScope

Methods inherited from class com.levigo.jadice.web.client.commands.AbstractMouseCommand

clearInjections, isDoubleClicked

Methods inherited from class com.levigo.jadice.web.client.commands.AbstractPageViewCommand

getPageView, setPageView

Methods inherited from class com.levigo.jadice.web.client.commands.AbstractContextCommand

getContext, propagateContextChange, setContext

Methods inherited from class com.levigo.jadice.web.client.util.command.InjectedCommand

canExecute, execute, getKey, isSelected, setKey

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.levigo.jadice.web.client.util.command.Command

isAvailable, isAvailable

Constructor Details

CreateAnnotationCommand

public CreateAnnotationCommand()

Method Details

getDebugId

public String getDebugId()

Specified by:

getDebugId in interface com.levigo.jadice.web.client.util.internal.HasDebugId

setAnnotationFactory

public void setAnnotationFactory(AnnotationProfile profile,
 AnnotationFactory factory)

execute

protected void execute()

Description copied from class: InjectedCommand

This method is called in order to execute the command. It is only called, after the arguments have been validated and injected and only if InjectedCommand.canExecute() has returned true.

Specified by:

execute in class InjectedCommand

isSelected

protected boolean isSelected()

Description copied from class: InjectedCommand

Returns the selected state of this command. This is typically used only for commands with a meaningful selection state.

Overrides:

isSelected in class InjectedCommand

Returns:

the selected state

canExecute

protected boolean canExecute()

Description copied from class: AbstractDocumentCommand

Checks if this command can be executed.

Overrides:

canExecute in class AbstractDocumentCommand

Returns:

true, if InjectedCommand.execute(java.util.Collection<java.lang.Object>) can be called, false else

setEditorHost

public void setEditorHost(AbstractBar editorHost)

Sets the context toolbar for the annotation tool.

Parameters:

editorHost - the context toolbar.

getCreateMode

public CreateAnnotationCommand.CreateMode getCreateMode()

setCreateMode

public void setCreateMode(CreateAnnotationCommand.CreateMode createMode)

setMouseEvent

public void setMouseEvent(com.google.gwt.event.dom.client.MouseEvent<?> mouseEvent)

Overrides:

setMouseEvent in class AbstractMouseCommand

getID

public String getID()

Description copied from interface: Command

The ID of the command. This is typically the command class name. If the Command is parameterized the ID should comprise the class name + parameter information.

Specified by:

getID in interface Command

Overrides:

getID in class AbstractDocumentCommand

Returns:

the ID of the command