public class EmbeddedAnnotationVisibilityCommand extends AbstractAnnotationCommand
Hint:
To work properly this command needs a PageView
instance in the
Context
object.
The following named command parameters exists and can be used to configure the command behavior.
Description | Command Parameter Name | Possible Parameter Values |
---|---|---|
The annotation types whose visibility should be changed | annotationTypes | a comma separated list of annotation types to be changed or "*" for all annotation types of the current annotation profile at execution time |
AbstractDocumentCommand
, the applied scope is
always AbstractDocumentCommand.Scope.DOCUMENT
independent of the inherited scope
.AbstractDocumentCommand.Scope
document
Constructor and Description |
---|
EmbeddedAnnotationVisibilityCommand() |
Modifier and Type | Method and Description |
---|---|
protected boolean |
canExecute()
Subclasses may override this method to perform argument validation beyond the validation that
happens automatically during the injection phase.
|
protected void |
execute()
This method is called in order to execute the command.
|
protected Collection<AnnotationType> |
getAnnotationTypes()
Tries to retrieve the toggle mode value from command parameters at given parameter index
|
boolean |
isSelected()
Returns the selected state of this command.
|
void |
setTypeNames(String typeNames) |
protected void |
toogleAnnotationVisibility()
Toggles visibility of annotations described by given class
|
getAnnoPageSegment, getAnnoRenderSettings, getAnnotationProfile, getAnnotations, getAnnotationTool, getSelectedAnnotations
getRenderControls, getScope, setScope
getPageView, setPageView
getContext, propagateContextChange, setContext
canExecute, execute, getKey, isAvailable, isSelected, setKey
protected Collection<AnnotationType> getAnnotationTypes()
-1
, if the parameter is not set or set to an invalid valueprotected void execute()
InjectedCommand
InjectedCommand.canExecute()
has returned
true
.execute
in class InjectedCommand
public boolean isSelected()
InjectedCommand
isSelected
in class InjectedCommand
protected void toogleAnnotationVisibility()
protected boolean canExecute()
InjectedCommand
Argument
annotations and the
arguments have been injected.canExecute
in class AbstractAnnotationCommand
true
if the command can/may be executed in the current context,
false
otherwise.InjectedCommand.canExecute(Collection)
public void setTypeNames(String typeNames)
Copyright © 2024 levigo holding gmbh. All rights reserved.