|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface PaneManager
The interface which defines common function that an aggregating user interface
manager must support. A PaneManager is capable of
rendering a complex user interface, consisting of multiple panels
which have been grouped together based on a specification defined
using the Panel Definition Markup Language (PDML).
PanelManager,
PropertySheetManager,
WizardManager,
DeckPaneManager,
SplitPaneManager,
TabbedPaneManager| Modifier and Type | Method and Description |
|---|---|
void |
activatePanel()
Runs the activation handlers for the currently selected pane. |
void |
applyChanges()
Transmits changes to user data to the DataBeans
which manage the data. |
void |
commit(Vector committedDataBeans)
Commits the changes to data displayed on the pane. |
PaneManager |
getAggregateManager()
Returns the owning PaneManager for the receiver. |
Component |
getComponent(String componentName)
Returns the requested user interface component. |
com.ibm.as400.ui.framework.java.JavaComponentDescriptor |
getComponentDescriptor(String componentName)
Returns the JavaComponentDescriptor for the specified user interface component. |
PaneManager |
getDelegateManager(String paneName)
Returns the PaneManager to which the receiver is delegating
management of the specified subpane. |
DataFormatter |
getFormatter(String componentName)
Returns the data formatter associated with the specified user interface component. |
PaneManager |
getRootManager()
Returns the root PaneManager for the receiver. |
String |
getTitle()
Returns the pane's title. |
void |
loadData()
Called during initialization to load data into the panel. |
void |
prepareToCommit(Vector preparedDataBeans)
Request the DataBeans which manage data for the
pane to verify that their data is in a consistent state. |
void |
setAggregateManager(PaneManager mgr)
Sets the owning PaneManager for the receiver. |
void |
setFormatter(String componentName,
DataFormatter formatter,
boolean required)
Sets the data formatter associated with the specified user interface component. |
void |
setHelpPath(String path)
Base location for help files. |
void |
showPane(String paneName)
Displays the specified pane. |
| Method Detail |
|---|
String getTitle()
void loadData()
void activatePanel()
void showPane(String paneName)
paneName - the name of the pane to be displayed, as defined in the PDML for this PaneManagerComponent getComponent(String componentName)
<panel_name>.<component_name>
where panel_name is the name of the panel containing
the desired component, and component_name is the
name of the component, as defined in the PDML for the panel definition.
componentName - the fully-qualified name of the user interface componentComponent, or null if the component cannot be foundcom.ibm.as400.ui.framework.java.JavaComponentDescriptor getComponentDescriptor(String componentName)
JavaComponentDescriptor for the specified user interface component.
The name of the component must be of the form
<panel_name>.<component_name>
where panel_name is the name of the panel containing
the desired component, and component_name is the
name of the component, as defined in the PDML for the panel definition.
componentName - the fully-qualified name of the user interface componentJavaComponentDescriptor, or null if the descriptor cannot be foundPaneManager getDelegateManager(String paneName)
PaneManager to which the receiver is delegating
management of the specified subpane.
paneName - the name of the pane as specified in the PDML definitionPaneManager, or null if the object cannot be foundvoid setAggregateManager(PaneManager mgr)
PaneManager for the receiver.
The specified object identifies the PaneManager
to which certain requests should be delegated when this PaneManager
is participating in an aggregate user interface.
mgr - the PaneManager with which the receiver is to be associatedPaneManager getAggregateManager()
PaneManager for the receiver.
PaneManager with which the receiver is associated
when this object is participating in an aggregate user interface, or null
if this PaneManager is not part of an aggregate.PaneManager getRootManager()
PaneManager for the receiver.
PaneManager for the main panel that is
managing the aggregate user interface, or null if this PaneManager
is not part of an aggregate.void applyChanges()
DataBeans
which manage the data.
Calls the settor methods for all UI components that have
accessor methods associated with them.
This method is called when the pane is about to be closed.
void prepareToCommit(Vector preparedDataBeans)
DataBeans which manage data for the
pane to verify that their data is in a consistent state.
Calls the verifyChanges method for all DataBeans
associated with the pane.
This method is called when the pane is about to be closed.
preparedDataBeans - a list of DataBeans which have already
been prepared on the current commit operationvoid commit(Vector committedDataBeans)
save method on all DataBeans
which manage data for the pane.
This method is called when the user indicates a desire to permanently save changes to the data, by clicking an OK button for example.
committedDataBeans - a list of DataBeans which have already
been saved on the current commit operation
void setFormatter(String componentName,
DataFormatter formatter,
boolean required)
componentName - the name of the user interface componentformatter - a reference to the data formatter to be associated with the componentrequired - whether a value is required to be enteredDataFormatter getFormatter(String componentName)
componentName - the name of the user interface componentDataFormatter, or null if the component cannot be foundDataFormattervoid setHelpPath(String path)
setHelpPath("http://www.ibm.com/help/") will
cause the PanelManager to load http://www.ibm.com/help/MyPanel.html as
the help file.
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||