com.levigo.jadice.demo.gradation.commands
Class GradationCommand

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.demo.gradation.commands.GradationCommand

All Implemented Interfaces:

Command

public class GradationCommand
extends AbstractDocumentCommand

Shows/Hide a gradation frame

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

Optional, as command parameter at index position 0, a decision flag can be set, if the gradation should be applied on the whole document or just on the currently displayed page of the viewer instance in the context object. Valid parameter values are document or page. If this parameter is not set or set to any other value, document execution is assumed.

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

GradationCommand()

Method Summary

protected void	execute() This method is called in order to execute the command.
protected GradationFrame	getGradationFrame() Returns the gradation frame which is contained in the given collection and has the same scope as this command instance.
boolean	isSelected() Returns the selected state of this command.
void	setScopeFrames(Collection<GradationFrame> scopeFrames) Deprecated. Will be used by injection exclusively.

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

canExecute, 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

GradationCommand

public GradationCommand()

Method Detail

setScopeFrames

@Deprecated
public void setScopeFrames(Collection<GradationFrame> scopeFrames)

Deprecated. Will be used by injection exclusively.

Invoked by command injection.

Developers should not invoke this method in any direct way.

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

getGradationFrame

protected GradationFrame getGradationFrame()

Returns the gradation frame which is contained in the given collection and has the same scope as this command instance. If no matching instance is contained null will be returned.

Returns:

matching gradation frame

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