org.springframework.richclient.command.support
Class ShowPageCommand

java.lang.Object
  org.springframework.binding.value.support.AbstractPropertyChangePublisher
      org.springframework.richclient.command.AbstractCommand
          org.springframework.richclient.command.ActionCommand
              org.springframework.richclient.command.support.ApplicationWindowAwareCommand
                  org.springframework.richclient.command.support.ShowPageCommand

All Implemented Interfaces:

BeanNameAware, InitializingBean, PropertyChangePublisher, ApplicationWindowAware, ActionCommandExecutor, GuardedActionCommandExecutor, ParameterizableActionCommandExecutor, Authorizable, Guarded, SecurityControllable

public class ShowPageCommand
extends ApplicationWindowAwareCommand
implements InitializingBean

An action command for displaying a Page based on a provided PageDescriptor.

Field Summary

Fields inherited from class org.springframework.richclient.command.ActionCommand

ACTION_COMMAND_PARAMETER_KEY, ACTION_COMMAND_PROPERTY, ACTION_EVENT_PARAMETER_KEY, MODIFIERS_PARAMETER_KEY

Fields inherited from class org.springframework.richclient.command.AbstractCommand

ENABLED_PROPERTY_NAME, VISIBLE_PROPERTY_NAME

Fields inherited from class org.springframework.binding.value.support.AbstractPropertyChangePublisher

logger

Fields inherited from interface org.springframework.richclient.core.Authorizable

AUTHORIZED_PROPERTY

Constructor Summary

ShowPageCommand()
Creates a new uninitialized ShowPageCommand.

ShowPageCommand(PageDescriptor pageDescriptor, ApplicationWindow applicationWindow)
Creates a new ShowPageCommand with the given page descriptor and associated application window.

Method Summary

void	afterPropertiesSet() Performs initialisation and validation of this instance after its dependencies have been set.
protected void	doExecuteCommand() Causes the page described by this instance's page descriptor to be shown.
void	setPageDescriptor(PageDescriptor pageDescriptor) Sets the descriptor for the page that is to be opened by this command object.

Methods inherited from class org.springframework.richclient.command.support.ApplicationWindowAwareCommand

getApplicationWindow, getParentWindowControl, setApplicationWindow

Methods inherited from class org.springframework.richclient.command.ActionCommand

addCommandInterceptor, addParameter, execute, execute, getActionAdapter, getActionCommand, getModifiers, getParameter, getParameter, getParameters, isDisplaysInputDialog, onButtonAttached, onPostExecute, onPreExecute, removeCommandInterceptor, setActionCommand, setDefaultButton, setDefaultButtonIn, setDisplaysInputDialog

Methods inherited from class org.springframework.richclient.command.AbstractCommand

addEnabledListener, attach, attach, attach, buttonIterator, createButton, createButton, createButton, createButton, createButton, createButton, createMenuItem, createMenuItem, createMenuItem, createMenuItem, createMenuItem, createMenuItem, defaultButtonIterator, detach, getAccelerator, getButtonFactory, getButtonIn, getCommandServices, getComponentFactory, getDefaultButtonConfigurer, getDefaultFaceDescriptorId, getFaceDescriptor, getFaceDescriptorRegistry, getIcon, getId, getMenuFactory, getMenuItemButtonConfigurer, getMnemonic, getMnemonicIndex, getSecurityControllerId, getText, getToolBarButtonConfigurer, getToolBarButtonFactory, isAnonymous, isAttached, isAuthorized, isEnabled, isFaceConfigured, isVisible, onButtonDetached, removeEnabledListener, requestFocusIn, setAuthorized, setBeanName, setCaption, setCommandServices, setDefaultFaceDescriptorId, setEnabled, setFaceDescriptor, setFaceDescriptor, setFaceDescriptorRegistry, setFaceDescriptors, setIcon, setIconInfo, setId, setLabel, setLabel, setSecurityControllerId, setVisible, toString, updatedEnabledState, updatedVisibleState

Methods inherited from class org.springframework.binding.value.support.AbstractPropertyChangePublisher

addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, addVetoableChangeListener, firePropertiesChanged, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, getPropertyChangeListeners, getPropertyChangeListeners, getVetoableChangeListeners, getVetoableChangeListeners, hasChanged, hasChanged, hasChanged, hasChanged, hasChanged, hasChanged, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, removeVetoableChangeListener

Methods inherited from class java.lang.Object

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

Constructor Detail

ShowPageCommand

public ShowPageCommand()

Creates a new uninitialized ShowPageCommand. The applicationWindow and pageDescriptor properties must be set before using the new instance.

ShowPageCommand

public ShowPageCommand(PageDescriptor pageDescriptor,
                       ApplicationWindow applicationWindow)

Creates a new ShowPageCommand with the given page descriptor and associated application window. The new instance will have a command identifier equal to the id from the page descriptor, the command will be enabled by default.

Parameters:

pageDescriptor - The object describing the page that this command will be responsible for showing.

applicationWindow - The application window that the command belongs to.

Method Detail

afterPropertiesSet

public void afterPropertiesSet()

Performs initialisation and validation of this instance after its dependencies have been set. If subclasses override this method, they should begin by calling super.afterPropertiesSet().

Specified by:

afterPropertiesSet in interface InitializingBean

Overrides:

afterPropertiesSet in class AbstractCommand

setPageDescriptor

public final void setPageDescriptor(PageDescriptor pageDescriptor)

Sets the descriptor for the page that is to be opened by this command object. This command object will be assigned the id, label, icon, and caption from the given page descriptor.

Parameters:

pageDescriptor - The page descriptor, cannot be null.

Throws:

IllegalArgumentException - if pageDescriptor is null.

doExecuteCommand

protected void doExecuteCommand()

Causes the page described by this instance's page descriptor to be shown.

Specified by:

doExecuteCommand in class ActionCommand