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
-
Nested Class Summary
Nested classes/interfaces inherited from class com.levigo.jadice.web.client.commands.AbstractDocumentCommand
AbstractDocumentCommand.Scope
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected String
TheAnnotation
type as it is defined within either theannotation-type
orannotation-template
tag in the annotation profile XML file.protected AnnotationProfile
TheAnnotationProfile
required to properly execute the command.protected String
The profile ID as it is set in the annotation profile XML file within the tagannotation-profile
. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected boolean
Checks if this command can be executed.protected AnnotationProfile
protected AnnotationRenderSettings
protected AnnotationTool
void
Loads anAnnotationProfile
which is required to create a newAnnotation
.void
setAnnotationType
(String annotationType) Sets theannotationType
.void
setProfileId
(String profileId) Sets theprofileId
.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
The profile ID as it is set in the annotation profile XML file within the tagannotation-profile
. -
profile
TheAnnotationProfile
required to properly execute the command.The profile is set upon calling
loadAnnotationProfile()
. -
annotationType
TheAnnotation
type as it is defined within either theannotation-type
orannotation-template
tag in the annotation profile XML file.
-
-
Constructor Details
-
AbstractAnnotationCommand
public AbstractAnnotationCommand()
-
-
Method Details
-
setProfileId
Sets theprofileId
.You must also call
loadAnnotationProfile()
;- Parameters:
profileId
- The profile ID as it is specified in the annotation profile XML file within the tagannotation-profile
.
-
setAnnotationType
Sets theannotationType
.- Parameters:
annotationType
- TheAnnotation
type as it is defined within either theannotation-type
orannotation-template
tag in the annotation profile file.
-
getAnnotationRenderSettings
-
canExecute
protected boolean canExecute()Description copied from class:AbstractDocumentCommand
Checks if this command can be executed.- Overrides:
canExecute
in classAbstractDocumentCommand
- Returns:
- true, if
InjectedCommand.execute(java.util.Collection<java.lang.Object>)
can be called, false else
-
loadAnnotationProfile
public void loadAnnotationProfile()Loads anAnnotationProfile
which is required to create a newAnnotation
.After the
AnnotationProfile
is completely loaded, set the fieldprofile
. A non-null profile indicates that the command can now be executed. -
getAnnotationProfile
-
getAnnotationTool
-