com.levigo.jadice.swing.annotation.commands
Class EmbeddedAnnotationVisibilityCommand

java.lang.Object
  com.levigo.util.swing.action.injection.InjectedCommand
      com.levigo.util.swing.action.AbstractContextCommand
          com.levigo.jadice.swing.commands.AbstractPageViewCommand
              com.levigo.jadice.swing.commands.AbstractDocumentCommand
                  com.levigo.jadice.swing.annotation.commands.AbstractAnnotationCommand
                      com.levigo.jadice.swing.annotation.commands.EmbeddedAnnotationVisibilityCommand

All Implemented Interfaces:

Command

public class EmbeddedAnnotationVisibilityCommand
extends AbstractAnnotationCommand

This command could be used to change the visibility of embedded annotations.

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.

Command parameters

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

Although this command is a subclass of AbstractDocumentCommand, the applied scope is always AbstractDocumentCommand.Scope.DOCUMENT independent of the inherited scope .

Nested Class Summary

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

AbstractDocumentCommand.Scope

Field Summary

Fields inherited from class com.levigo.jadice.swing.commands.AbstractDocumentCommand

document

Constructor Summary

EmbeddedAnnotationVisibilityCommand()

Method Summary

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

Methods inherited from class com.levigo.jadice.swing.annotation.commands.AbstractAnnotationCommand

getAnnoPageSegment, getAnnoRenderSettings, getAnnotationProfile, getAnnotations, getAnnotationTool, getSelectedAnnotations

Methods inherited from class com.levigo.jadice.swing.commands.AbstractDocumentCommand

getRenderControls, getScope, setScope

Methods inherited from class com.levigo.jadice.swing.commands.AbstractPageViewCommand

getPageView, setPageView

Methods inherited from class com.levigo.util.swing.action.AbstractContextCommand

getContext, propagateContextChange, setContext

Methods inherited from class com.levigo.util.swing.action.injection.InjectedCommand

canExecute, execute, getKey, isAvailable, isSelected, setKey

Methods inherited from class java.lang.Object

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

Constructor Detail

EmbeddedAnnotationVisibilityCommand

public EmbeddedAnnotationVisibilityCommand()

Method Detail

getAnnotationTypes

protected Collection<AnnotationType> getAnnotationTypes()

Tries to retrieve the toggle mode value from command parameters at given parameter index

Returns:

found mode or -1, if the parameter is not set or set to an invalid value

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

public 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

toogleAnnotationVisibility

protected void toogleAnnotationVisibility()

Toggles visibility of annotations described by given class

canExecute

protected boolean canExecute()

Description copied from class: InjectedCommand

Subclasses may override this method to perform argument validation beyond the validation that happens automatically during the injection phase. This method is called after the context has been found to match the requirements specified via the Argument annotations and the arguments have been injected.

Overrides:

canExecute in class AbstractAnnotationCommand

Returns:

true if the command can/may be executed in the current context, false otherwise.

See Also:

InjectedCommand.canExecute(Collection)

setTypeNames

public void setTypeNames(String typeNames)