org.springframework.richclient.application
Interface ViewDescriptor

All Superinterfaces:

DescribedElement, PageComponentDescriptor, PropertyChangePublisher, VisualizedElement

All Known Implementing Classes:

DefaultViewDescriptor, DesktopViewDescriptor, FlexDockViewDescriptor, LookupViewDescriptor, VLDockingViewDescriptor

public interface ViewDescriptor
extends PageComponentDescriptor

Metadata about a view; a view descriptor is effectively a singleton view definition. A descriptor also acts as a factory which produces new instances of a given view when requested, typically by a requesting application page. A view descriptor can also produce a command which launches a view for display on the page within the current active window.

Author:

Keith Donald

Field Summary

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

CAPTION_PROPERTY, DESCRIPTION_PROPERTY, DISPLAY_NAME_PROPERTY

Method Summary

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.
CommandButtonLabelInfo	getShowViewCommandLabel()

Methods inherited from interface org.springframework.richclient.application.PageComponentDescriptor

createPageComponent, getId

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

Method Detail

createShowViewCommand

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.

Parameters:

window - The window

Returns:

The show page component command.

getShowViewCommandLabel

CommandButtonLabelInfo getShowViewCommandLabel()