org.springframework.richclient.command.support
Class ApplicationWindowAwareCommand

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

All Implemented Interfaces:

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

Direct Known Subclasses:

AboutCommand, ExitCommand, HelpContentsCommand, LoginCommand, LogoutCommand, NewWindowCommand, ShowPageCommand, ShowViewCommand, TitleBarTimeStampCommand

public abstract class ApplicationWindowAwareCommand
extends ActionCommand
implements ApplicationWindowAware

A skeleton implementation of an action command that needs to be aware of the ApplicationWindow in which it resides.

Author:

Keith Donald

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

protected	ApplicationWindowAwareCommand() Creates a new uninitialized ApplicationWindowAwareCommand.
protected	ApplicationWindowAwareCommand(String commandId) Creates a new ApplicationWindowAwareCommand with the given command identifier.

Method Summary

protected ApplicationWindow	getApplicationWindow() Returns the application window that this component was created within.
protected JFrame	getParentWindowControl() Returns the JFrame of the application window that this command belongs to.
void	setApplicationWindow(ApplicationWindow window) Sets the reference to the application window that this object was created within.

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

addCommandInterceptor, addParameter, doExecuteCommand, 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, afterPropertiesSet, 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

ApplicationWindowAwareCommand

protected ApplicationWindowAwareCommand()

Creates a new uninitialized ApplicationWindowAwareCommand.

ApplicationWindowAwareCommand

protected ApplicationWindowAwareCommand(String commandId)

Creates a new ApplicationWindowAwareCommand with the given command identifier.

Parameters:

commandId - The identifier of this command instance. This should be unique amongst all comands within the application.

Method Detail

setApplicationWindow

public void setApplicationWindow(ApplicationWindow window)

Sets the reference to the application window that this object was created within.

Specified by:

setApplicationWindow in interface ApplicationWindowAware

Parameters:

window - The application window containing this component.

getApplicationWindow

protected ApplicationWindow getApplicationWindow()

Returns the application window that this component was created within.

Returns:

The application window, or null if this property has not yet been initialized.

getParentWindowControl

protected JFrame getParentWindowControl()

Returns the JFrame of the application window that this command belongs to.

Returns:

The control component of the application window, never null.