org.springframework.richclient.application
Interface PageComponentDescriptor

Show UML class diagram

All Superinterfaces:

DescribedElement, PropertyChangePublisher, VisualizedElement

All Known Subinterfaces:

ViewDescriptor

All Known Implementing Classes:

DefaultViewDescriptor, DesktopViewDescriptor, FlexDockViewDescriptor, LookupViewDescriptor, SimpleViewDescriptor, VLDockingViewDescriptor, WidgetViewDescriptor

public interface PageComponentDescriptor
extends PropertyChangePublisher, DescribedElement, VisualizedElement

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

Field Summary

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

CAPTION_PROPERTY, DESCRIPTION_PROPERTY, DISPLAY_NAME_PROPERTY

Method Summary

PageComponent	createPageComponent() Creates the page component defined by this descriptor.
String	getId() Returns the identifier of this descriptor.

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

getId

String getId()

Returns the identifier of this descriptor.

Returns:

The descriptor id.

createPageComponent

PageComponent createPageComponent()

Creates the page component defined by this descriptor.

Returns:

The page component, never null.