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

All Known Implementing Classes:
DeckPaneManager, PanelManager, PropertySheetManager, SplitPaneManager, TabbedPaneManager, WizardManager

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

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

Method Summary
 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(java.util.Vector committedDataBeans)
          Commits the changes to data displayed on the pane.
 PaneManager getAggregateManager()
          Returns the owning PaneManager for the receiver.
 java.awt.Component getComponent(java.lang.String componentName)
          Returns the requested user interface component.
 com.ibm.as400.ui.framework.java.JavaComponentDescriptor getComponentDescriptor(java.lang.String componentName)
          Returns the JavaComponentDescriptor for the specified user interface component.
 PaneManager getDelegateManager(java.lang.String paneName)
          Returns the PaneManager to which the receiver is delegating management of the specified subpane.
 DataFormatter getFormatter(java.lang.String componentName)
          Returns the data formatter associated with the specified user interface component.
 PaneManager getRootManager()
          Returns the root PaneManager for the receiver.
 java.lang.String getTitle()
          Returns the pane's title.
 void loadData()
          Called during initialization to load data into the panel.
 void prepareToCommit(java.util.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(java.lang.String componentName, DataFormatter formatter, boolean required)
          Sets the data formatter associated with the specified user interface component.
 void setHelpPath(java.lang.String path)
          Base location for help files.
 void showPane(java.lang.String paneName)
          Displays the specified pane.
 

Method Detail

getTitle

public java.lang.String getTitle()
Returns the pane's title.
Returns:
the title specified in the PDML definition for the pane
Since:
v4r2m0

loadData

public void loadData()
Called during initialization to load data into the panel.
Since:
v4r2m0

activatePanel

public void activatePanel()
Runs the activation handlers for the currently selected pane.
Since:
v4r2m0

showPane

public void showPane(java.lang.String paneName)
Displays the specified pane.
Parameters:
paneName - the name of the pane to be displayed, as defined in the PDML for this PaneManager
Since:
v4r2m0

getComponent

public java.awt.Component getComponent(java.lang.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
Since:
v4r2m0

getComponentDescriptor

public com.ibm.as400.ui.framework.java.JavaComponentDescriptor getComponentDescriptor(java.lang.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
Since:
v4r2m0

getDelegateManager

public PaneManager getDelegateManager(java.lang.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
Since:
v4r2m0

setAggregateManager

public 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
Since:
v4r2m0

getAggregateManager

public 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.
Since:
v4r5m0

getRootManager

public 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.
Since:
v4r5m0

applyChanges

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

Since:
v4r2m0

prepareToCommit

public void prepareToCommit(java.util.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
Since:
v4r2m0

commit

public void commit(java.util.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
Since:
v4r2m0

setFormatter

public void setFormatter(java.lang.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
Since:
v4r2m0

getFormatter

public DataFormatter getFormatter(java.lang.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
Since:
v4r2m0
See Also:
DataFormatter

setHelpPath

public void setHelpPath(java.lang.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.
Since:
v4r2m0