com.levigo.jadice.swing.commands
Class TurnPageCommand

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.commands.TurnPageCommand

All Implemented Interfaces:

Command

public class TurnPageCommand
extends AbstractDocumentCommand

This command could be used for page browsing purposes. The viewer which should be controlled by this command have to be provided as context object of the used context. The way how the pages should be toggled is defined via command properties file.

This method must be parameterized with the navigation mode. See setMode(Mode) and TurnPageCommand.Mode.

Hint:
To work properly this command needs a PageView instance in the Context object.

Nested Class Summary

static class

TurnPageCommand.Mode The navigation mode.

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

TurnPageCommand()

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.
TurnPageCommand.Mode	getMode()
void	setMode(TurnPageCommand.Mode mode) Set the navigation mode.

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, isSelected, setKey

Methods inherited from class java.lang.Object

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

Constructor Detail

TurnPageCommand

public TurnPageCommand()

Method Detail

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

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 AbstractDocumentCommand

Returns:

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

See Also:

InjectedCommand.canExecute(Collection)

setMode

public void setMode(TurnPageCommand.Mode mode)

Set the navigation mode. See TurnPageCommand.Mode.

Parameters:

mode -

getMode

public TurnPageCommand.Mode getMode()