All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface com.ibm.as400.ui.framework.java.PaneManager

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).

See Also:
PanelManager, PropertySheetManager, WizardManager, DeckPaneManager, SplitPaneManager, TabbedPaneManager

Method Index

 o activatePanel()
Runs the activation handlers for the currently selected pane.
 o applyChanges()
Transmits changes to user data to the DataBeans which manage the data.
 o commit(Vector)
Commits the changes to data displayed on the pane.
 o getAggregateManager()
Returns the owning PaneManager for the receiver.
 o getComponent(String)
Returns the requested user interface component.
 o getComponentDescriptor(String)
Returns the JavaComponentDescriptor for the specified user interface component.
 o getDelegateManager(String)
Returns the PaneManager to which the receiver is delegating management of the specified subpane.
 o getFormatter(String)
Returns the data formatter associated with the specified user interface component.
 o getRootManager()
Returns the root PaneManager for the receiver.
 o getTitle()
Returns the pane's title.
 o loadData()
Called during initialization to load data into the panel.
 o prepareToCommit(Vector)
Request the DataBeans which manage data for the pane to verify that their data is in a consistent state.
 o setAggregateManager(PaneManager)
Sets the owning PaneManager for the receiver.
 o setFormatter(String, DataFormatter, boolean)
Sets the data formatter associated with the specified user interface component.
 o setHelpPath(String)
Base location for help files.
 o showPane(String)
Displays the specified pane.

Methods

 o getTitle
 public abstract String getTitle()
Returns the pane's title.

Returns:
the title specified in the PDML definition for the pane
 o loadData
 public abstract void loadData()
Called during initialization to load data into the panel.

 o activatePanel
 public abstract void activatePanel()
Runs the activation handlers for the currently selected pane.

 o showPane
 public abstract void showPane(String paneName)
Displays the specified pane.

Parameters:
paneName - the name of the pane to be displayed, as defined in the PDML for this PaneManager
 o getComponent
 public abstract Component getComponent(String componentName)
Returns the requested 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.

Parameters:
componentName - the fully-qualified name of the user interface component
Returns:
the desired Component, or null if the component cannot be found
 o getComponentDescriptor
 public abstract JavaComponentDescriptor getComponentDescriptor(String componentName)
Returns the 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.

Parameters:
componentName - the fully-qualified name of the user interface component
Returns:
the desired JavaComponentDescriptor, or null if the descriptor cannot be found
 o getDelegateManager
 public abstract PaneManager getDelegateManager(String paneName)
Returns the PaneManager to which the receiver is delegating management of the specified subpane.

Parameters:
paneName - the name of the pane as specified in the PDML definition
Returns:
the desired PaneManager, or null if the object cannot be found
 o setAggregateManager
 public abstract void setAggregateManager(PaneManager mgr)
Sets the owning 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.

Parameters:
mgr - the PaneManager with which the receiver is to be associated
 o getAggregateManager
 public abstract PaneManager getAggregateManager()
Returns the owning PaneManager for the receiver.

Returns:
the 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.
 o getRootManager
 public abstract PaneManager getRootManager()
Returns the root PaneManager for the receiver.

Returns:
the PaneManager for the main panel that is managing the aggregate user interface, or null if this PaneManager is not part of an aggregate.
 o applyChanges
 public abstract void applyChanges()
Transmits changes to user data to the 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.

 o prepareToCommit
 public abstract void prepareToCommit(Vector preparedDataBeans)
Request the 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.

Parameters:
preparedDataBeans - a list of DataBeans which have already been prepared on the current commit operation
 o commit
 public abstract void commit(Vector committedDataBeans)
Commits the changes to data displayed on the pane. Calls the 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.

Parameters:
committedDataBeans - a list of DataBeans which have already been saved on the current commit operation
 o setFormatter
 public abstract void setFormatter(String componentName,
                                   DataFormatter formatter,
                                   boolean required)
Sets the data formatter associated with the specified user interface component.

Parameters:
componentName - the name of the user interface component
formatter - a reference to the data formatter to be associated with the component
required - whether a value is required to be entered
 o getFormatter
 public abstract DataFormatter getFormatter(String componentName)
Returns the data formatter associated with the specified user interface component.

Parameters:
componentName - the name of the user interface component
Returns:
the associated DataFormatter, or null if the component cannot be found
See Also:
DataFormatter
 o setHelpPath
 public abstract void setHelpPath(String path)
Base location for help files. For use in the no-plugin applet case. For example for MyPanel, setHelpPath("http://www.ibm.com/help/") will cause the PanelManager to load http://www.ibm.com/help/MyPanel.html as the help file.


All Packages  Class Hierarchy  This Package  Previous  Next  Index