org.springframework.richclient.application.support
Class DefaultViewDescriptor

Show UML class diagram

java.lang.Object
  org.springframework.richclient.application.support.ApplicationServicesAccessor
      org.springframework.richclient.core.LabeledObjectSupport
          org.springframework.richclient.application.support.DefaultViewDescriptor

All Implemented Interfaces:

BeanNameAware, InitializingBean, PropertyChangePublisher, PageComponentDescriptor, ViewDescriptor, CommandLabelConfigurable, DescribedElement, DescriptionConfigurable, TitleConfigurable, VisualizedElement, ImageConfigurable

Direct Known Subclasses:

DesktopViewDescriptor, FlexDockViewDescriptor, VLDockingViewDescriptor, WidgetViewDescriptor

public class DefaultViewDescriptor
extends LabeledObjectSupport
implements ViewDescriptor, BeanNameAware, InitializingBean

Provides a standard implementation of ViewDescriptor.

Author:

Keith Donald

Field Summary

Fields inherited from class org.springframework.richclient.core.LabeledObjectSupport

logger

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

CAPTION_PROPERTY, DESCRIPTION_PROPERTY, DISPLAY_NAME_PROPERTY

Constructor Summary

DefaultViewDescriptor()

DefaultViewDescriptor(String id, Class<? extends View> viewClass)

DefaultViewDescriptor(String id, Class<? extends View> viewClass, Map<String,Object> viewProperties)

Method Summary

void	afterPropertiesSet()
PageComponent	createPageComponent() Creates the page component defined by this descriptor.
ActionCommand	createShowViewCommand(ApplicationWindow window) Create a command that when executed, will attempt to show the page component described by this descriptor in the provided application window.
protected View	createView()
String	getId() Returns the identifier of this descriptor.
CommandButtonLabelInfo	getShowViewCommandLabel()
Class<? extends View>	getViewClass()
void	setBeanName(String beanName)
void	setId(String id)
void	setViewClass(Class<? extends View> viewClass)
void	setViewProperties(Map<String,Object> viewProperties)

Methods inherited from class org.springframework.richclient.core.LabeledObjectSupport

addPropertyChangeListener, addPropertyChangeListener, firePropertyChange, firePropertyChange, firePropertyChange, getAccelerator, getCaption, getDescription, getDisplayName, getIcon, getImage, getLabel, getMnemonic, getMnemonicIndex, hasChanged, hasChanged, hasChanged, removePropertyChangeListener, removePropertyChangeListener, setCaption, setDescription, setImage, setLabelInfo, setTitle, toString

Methods inherited from class org.springframework.richclient.application.support.ApplicationServicesAccessor

getActiveWindow, getApplication, getApplicationContext, getApplicationName, getApplicationServices, getCommandConfigurer, getComponentFactory, getConversionService, getIconSource, getImageSource, getMessage, getMessage, getMessage, getMessage, getMessages, getMessageSource, getObjectConfigurer, getService

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.binding.value.PropertyChangePublisher

addPropertyChangeListener, addPropertyChangeListener, removePropertyChangeListener, removePropertyChangeListener

Methods inherited from interface org.springframework.richclient.core.DescribedElement

getCaption, getDescription, getDisplayName

Methods inherited from interface org.springframework.richclient.core.VisualizedElement

getIcon, getImage

Constructor Detail

DefaultViewDescriptor

public DefaultViewDescriptor()

DefaultViewDescriptor

public DefaultViewDescriptor(String id,
                             Class<? extends View> viewClass)

DefaultViewDescriptor

public DefaultViewDescriptor(String id,
                             Class<? extends View> viewClass,
                             Map<String,Object> viewProperties)

Method Detail

setBeanName

public void setBeanName(String beanName)

Specified by:

setBeanName in interface BeanNameAware

setId

public void setId(String id)

getId

public String getId()

Description copied from interface: PageComponentDescriptor

Returns the identifier of this descriptor.

Specified by:

getId in interface PageComponentDescriptor

Returns:

The descriptor id.

getViewClass

public Class<? extends View> getViewClass()

setViewClass

public void setViewClass(Class<? extends View> viewClass)

setViewProperties

public void setViewProperties(Map<String,Object> viewProperties)

createPageComponent

public PageComponent createPageComponent()

Description copied from interface: PageComponentDescriptor

Creates the page component defined by this descriptor.

Specified by:

createPageComponent in interface PageComponentDescriptor

Returns:

The page component, never null.

createView

protected View createView()

getShowViewCommandLabel

public CommandButtonLabelInfo getShowViewCommandLabel()

Specified by:

getShowViewCommandLabel in interface ViewDescriptor

createShowViewCommand

public ActionCommand createShowViewCommand(ApplicationWindow window)

Description copied from interface: ViewDescriptor

Create a command that when executed, will attempt to show the page component described by this descriptor in the provided application window.

Specified by:

createShowViewCommand in interface ViewDescriptor

Parameters:

window - The window

Returns:

The show page component command.

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface InitializingBean

Throws:

Exception