|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES All Classes | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.springframework.richclient.application.support.ApplicationServicesAccessor
org.springframework.richclient.core.LabeledObjectSupport
org.springframework.richclient.dialog.AbstractDialogPage
org.springframework.richclient.dialog.CompositeDialogPage
public abstract class CompositeDialogPage
An implementation of the DialogPage
interface that collects a
group of dialog pages together so that they can be used in place of a single
DialogPage
It is expected that subclasses will provide various ways of displaying the active page and navigating to inactive child pages.
Services of a CompositeDialogPage
include:
TabbedDialogPage
Nested Class Summary | |
---|---|
protected class |
CompositeDialogPage.ChildChangeHandler
|
Field Summary |
---|
Fields inherited from class org.springframework.richclient.core.LabeledObjectSupport |
---|
logger |
Fields inherited from interface org.springframework.richclient.dialog.DialogPage |
---|
DESCRIPTION_PROPERTY, PAGE_COMPLETE_PROPERTY |
Fields inherited from interface org.springframework.richclient.dialog.Messagable |
---|
MESSAGE_PROPERTY |
Fields inherited from interface org.springframework.richclient.core.DescribedElement |
---|
CAPTION_PROPERTY, DESCRIPTION_PROPERTY, DISPLAY_NAME_PROPERTY |
Constructor Summary | |
---|---|
CompositeDialogPage(String pageId)
|
|
CompositeDialogPage(String pageId,
boolean autoConfigure)
|
Method Summary | |
---|---|
DialogPage |
addForm(Form form)
Adds a new page to the list of pages managed by this CompositeDialogPage. |
void |
addPage(DialogPage page)
Adds a DialogPage to the list of pages managed by this CompositeDialogPage. |
protected void |
addPages()
Subclasses should extend if extra pages need to be added before the composite creates its control. |
void |
addPages(DialogPage[] pages)
Adds an array DialogPage to the list of pages managed by this CompositeDialogPage. |
protected DialogPage |
createDialogPage(Form form)
|
protected void |
createPageControls()
|
protected String |
decoratePageTitle(DialogPage page,
String title)
Decorates the page title of the given DialogPage . |
DialogPage |
getActivePage()
Gets the active page of this CompositeDialogPage. |
protected String |
getDecoratedPageTitle(DialogPage page)
|
Dimension |
getLargestPageSize()
Get the size of the largest page added so far. |
protected List |
getPages()
|
protected void |
onPageSelected(DialogPage page,
boolean selected)
|
protected void |
prepareDialogPage(DialogPage page)
Prepare a dialog page - Add our property listeners and configure the control's look. |
void |
setActivePage(DialogPage activePage)
Sets the active page of this CompositeDialogPage. |
void |
setAutoConfigureChildPages(boolean autoConfigure)
|
protected void |
updateMessage()
|
protected void |
updatePageComplete(DialogPage page)
|
protected void |
updatePageEnabled(DialogPage page)
|
protected void |
updatePageLabels(DialogPage page)
|
protected void |
updatePageVisibility(DialogPage page)
|
Methods inherited from class org.springframework.richclient.dialog.AbstractDialogPage |
---|
createControl, getControl, getIcon, getId, getMessage, getParentWindowControl, getTitle, hasErrorMessage, hasInfoMessage, hasWarningMessage, isControlCreated, isEnabled, isPageComplete, isVisible, performHelp, setEnabled, setIcon, setId, setMessage, setPageComplete, setVisible |
Methods inherited from class org.springframework.richclient.core.LabeledObjectSupport |
---|
addPropertyChangeListener, addPropertyChangeListener, firePropertyChange, firePropertyChange, firePropertyChange, getAccelerator, getCaption, getDescription, getDisplayName, 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.richclient.dialog.DialogPage |
---|
getDescription, getImage |
Methods inherited from interface org.springframework.binding.value.PropertyChangePublisher |
---|
addPropertyChangeListener, addPropertyChangeListener, removePropertyChangeListener, removePropertyChangeListener |
Constructor Detail |
---|
public CompositeDialogPage(String pageId)
public CompositeDialogPage(String pageId, boolean autoConfigure)
Method Detail |
---|
public void setAutoConfigureChildPages(boolean autoConfigure)
public void addPage(DialogPage page)
page
- the page to addpublic DialogPage addForm(Form form)
formPage
- the form page to be insterted
public void addPages(DialogPage[] pages)
pages
- the pages to addprotected void addPages()
addPage
.
protected List getPages()
public void setActivePage(DialogPage activePage)
activePage
- the page to be made active. Must be one of the child
pages.public DialogPage getActivePage()
protected DialogPage createDialogPage(Form form)
protected void createPageControls()
protected void prepareDialogPage(DialogPage page)
page
- to processpublic Dimension getLargestPageSize()
protected void updatePageComplete(DialogPage page)
protected void updatePageEnabled(DialogPage page)
protected void updatePageLabels(DialogPage page)
protected void updateMessage()
protected void onPageSelected(DialogPage page, boolean selected)
protected void updatePageVisibility(DialogPage page)
protected final String getDecoratedPageTitle(DialogPage page)
protected String decoratePageTitle(DialogPage page, String title)
DialogPage
.
Can be overridden to provide additional decorations.
The default implementation returns a html with an indication whether the page is complete or incomplete
page
- the pagetitle
- the title
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES All Classes | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |