com.levigo.util.swing.action
Interface Command

All Known Subinterfaces:

SelfDescribingCommand

All Known Implementing Classes:

AbstractAnnotationCommand, AbstractAnnotationModeCommand, AbstractContextCommand, AbstractDocumentCommand, AbstractNavigablePreviewCommand, AbstractPageViewCommand, AbstractSelectionCommand, AbstractToggleSearchCommand, AbstractToolActivationCommand, ActivateRolloutSearchCommand, AnnotationDeleteCommand, AnnotationEditActivationCommand, AnnotationModeCommand, AnnotationSelectAllCommand, AnnotationVisibilityCommand, CloseDemoCommand, CopyRasterizedSelectionCommand, CopyRasterizedSelectionCommand, CopySelectedTextCommand, CopySelectedTextCommand, DemoPrint, DirectPrintDocumentCommand, DragTextActivationCommand, DummyCommand, EmbeddedAnnotationVisibilityCommand, FirstPageCommand, GradationCommand, InjectedCommand, LastPageCommand, LensActivationCommand, NextPageCommand, OpenDocumentFromFileCommand, OpenViewerFrameCommand, PanActivationCommand, PreviousPageCommand, PrintDocumentCommand, RedoCommand, RemoveDocumentFromPageViewCommand, RotateCommand, ScrollCommand, SelectPageLayoutCommand, ShowPDFPermissionsCommand, ShowProductInfoWindowCommand, ShowTrayLicenseCommand, SorterClearSelectionCommand, SorterSelectAllCommand, SpinCommand, ThumbnailResizeCommand, ToggleCaseSensitiveCommand, ToggleCompareCommand, ToggleCrosshairCommand, ToggleExtendedSearchCommand, ToggleFontRenderModeCommand, ToggleInfoAreaCommand, ToggleInfoTreeCommand, ToggleLensCommand, ToggleNavigatorCommand, ToggleSorterCommand, ToggleToolActivationPolicyCommand, ToggleToolbarVisibilityCommand, ToggleToolCommand, ToggleTrayCommand, ToggleUseImageUpscalingCommand, ToggleWholeWordsOnlyCommand, TurnPageCommand, UndoCommand, ZoomCommand, ZoomToSelectionCommand

public interface Command

Basic interface for all commands.

Version:

$Data$ $Revision$

Author:

l.boureanu@levigo.de

Method Summary

boolean	canExecute(Collection<Object> args) Permission checking for a command works as follows:
void	execute(Collection<Object> args) Execute the command.
boolean	isAvailable() Returns an indicator whether the command is available and therefore integrable.
boolean	isSelected(Collection<Object> args) Returns the selected state of this command.

Method Detail

execute

void execute(Collection<Object> args)

Execute the command.

Parameters:

args - arguments for the command (contains all items for all actions inside of the context!)

canExecute

boolean canExecute(Collection<Object> args)

Permission checking for a command works as follows:

1. Check user privileges if the command is executable.
2. Ask if the command is executable with the given objects.

Parameters:

args - arguments for the command

Returns:

true - executable with these arguments,
false - impossible to execute this command with these arguments

isSelected

boolean isSelected(Collection<Object> args)

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

Parameters:

args - arguments for the command

Returns:

true - selected with these arguments,
false - not selected with these arguments

isAvailable

boolean isAvailable()

Returns an indicator whether the command is available and therefore integrable.

Returns:

true - available false - not available