org.springframework.richclient.application
Interface PageComponent

All Superinterfaces:
ControlFactory, DescribedElement, PropertyChangePublisher, VisualizedElement
All Known Subinterfaces:
Editor, View
All Known Implementing Classes:
AbstractView, ContactView, ExceptionHandlingView, InitialView, InitialView, OwnerManagerView, ScriptedView, VetManagerView

public interface PageComponent
extends PropertyChangePublisher, DescribedElement, VisualizedElement, ControlFactory

A page component is displayed within an area on the page associated with an application window. There can be multiple components per page; a single page component can only be displayed once on a single page. Components instances encapsulate the creation of and access to the visual presentation of the underlying control. A component's descriptor -- which is effectively a singleton -- can be asked to instantiate new instances of a single page component for display within an application with multiple windows. In other words, a single page component instance is never shared between windows.

Author:
Keith Donald

Field Summary
 
Fields inherited from interface org.springframework.richclient.core.DescribedElement
CAPTION_PROPERTY, DESCRIPTION_PROPERTY, DISPLAY_NAME_PROPERTY
 
Method Summary
 boolean canClose()
           
 void close()
           
 void componentClosed()
           
 void componentFocusGained()
           
 void componentFocusLost()
           
 void componentOpened()
           
 void dispose()
           
 PageComponentContext getContext()
           
 String getId()
           
 void setContext(PageComponentContext context)
           
 void setDescriptor(PageComponentDescriptor pageComponentDescriptor)
           
 
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
 
Methods inherited from interface org.springframework.richclient.factory.ControlFactory
getControl
 

Method Detail

getContext

PageComponentContext getContext()

componentOpened

void componentOpened()

componentFocusGained

void componentFocusGained()

componentFocusLost

void componentFocusLost()

componentClosed

void componentClosed()

dispose

void dispose()

setContext

void setContext(PageComponentContext context)

setDescriptor

void setDescriptor(PageComponentDescriptor pageComponentDescriptor)

getId

String getId()

canClose

boolean canClose()

close

void close()


Copyright © 2004-2008 The Spring Framework. All Rights Reserved.