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

Class AbstractAnnotationCommand

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.AbstractAnnotationCommand

All Implemented Interfaces:

Command

Direct Known Subclasses:

AnnotationVisibilityCommand

public abstract class AbstractAnnotationCommand
extends AbstractDocumentCommand

Nested Class Summary

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

AbstractDocumentCommand.Scope

Field Summary

Fields

Modifier and Type	Field	Description
protected String	annotationType	The Annotation type as it is defined within either the annotation-type or annotation-template tag in the annotation profile XML file.
protected AnnotationProfile	profile	The AnnotationProfile required to properly execute the command.
protected String	profileId	The profile ID as it is set in the annotation profile XML file within the tag annotation-profile.

Constructor Summary

Constructors

Constructor	Description
AbstractAnnotationCommand()

Method Summary

Modifier and Type	Method	Description
protected boolean	canExecute()	Checks if this command can be executed.
protected AnnotationProfile	getAnnotationProfile()
protected AnnotationRenderSettings	getAnnotationRenderSettings()
protected AnnotationTool	getAnnotationTool()
void	loadAnnotationProfile()	Loads an AnnotationProfile which is required to create a new Annotation.
void	setAnnotationType(String annotationType)	Sets the annotationType.
void	setProfileId(String profileId)	Sets the profileId.

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

getDocument, getID, getRenderControls, getScope, setScope

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

clearInjections, isDoubleClicked, setMouseEvent

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, execute, getKey, isSelected, 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

Field Details

profileId

protected String profileId

The profile ID as it is set in the annotation profile XML file within the tag annotation-profile.

profile

protected AnnotationProfile profile

The AnnotationProfile required to properly execute the command.

The profile is set upon calling loadAnnotationProfile().

annotationType

protected String annotationType

The Annotation type as it is defined within either the annotation-type or annotation-template tag in the annotation profile XML file.

Constructor Details

AbstractAnnotationCommand

public AbstractAnnotationCommand()

Method Details

setProfileId

public void setProfileId(String profileId)

Sets the profileId.

You must also call loadAnnotationProfile();

Parameters:

profileId - The profile ID as it is specified in the annotation profile XML file within the tag annotation-profile.

setAnnotationType

public void setAnnotationType(String annotationType)

Sets the annotationType.

Parameters:

annotationType - The Annotation type as it is defined within either the annotation-type or annotation-template tag in the annotation profile file.

getAnnotationRenderSettings

protected AnnotationRenderSettings getAnnotationRenderSettings()

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

loadAnnotationProfile

public void loadAnnotationProfile()

Loads an AnnotationProfile which is required to create a new Annotation.

After the AnnotationProfile is completely loaded, set the field profile. A non-null profile indicates that the command can now be executed.

getAnnotationProfile

protected AnnotationProfile getAnnotationProfile()

getAnnotationTool

protected AnnotationTool getAnnotationTool()