All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.ibm.as400.ui.framework.java.DeckPaneManager

java.lang.Object
   |
   +----com.ibm.as400.ui.framework.java.DeckPaneManager

public class DeckPaneManager
extends Object
implements PaneManager
Creates a subpanel containing a series of windows which are displayed one at a time. The subpanel acts as a stack or "deck" of windows. Each window consists of a panel defined using the Panel Definition Markup Language (PDML).

DeckPaneManager does not implement the WindowManager interface, and thus cannot be used to create a standalone window or dialog. It is designed to be incorporated in the definition of an existing panel, property sheet or wizard. Applications normally do not construct DeckPaneManagers directly. Instead, a reference to the DeckPaneManager for a particular subpanel is obtained by calling getDelegateManager on the PaneManager for the containing panel.

DeckPaneManager performs the following processing on behalf of the application:

The total size of the deck pane is a function of the size of the largest panel.

See Also:
getDelegateManager, PanelManager

Constructor Index

 o DeckPaneManager(String, Locale, String)
Constructs a DeckPaneManager object for the specified deck pane, and then serializes the deck pane definition.
 o DeckPaneManager(String, Locale, String, DataBean[], Container)
Constructs a DeckPaneManager for the specified deck pane, using the specified container.
 o DeckPaneManager(String, String, DataBean[], Container)
Constructs a DeckPaneManager for the specified deck pane, using the specified container.

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 getPaneNames()
Returns a list of the panes in the deck.
 o getPreferredSize()
Gets the preferred size of this deck pane.
 o getRootManager()
Returns the root PaneManager for the receiver.
 o getTitle()
Returns the deck pane's title.
 o loadData()
Called during initialization to load data into the pane.
 o main(String[])
Provides a command line interface to DeckPaneManager.
 o prepareToCommit(Vector)
Request the DataBeans which manage data for the panel to verify that their data is in a consistent state.
 o serialize()
Serializes the deck pane definition.
 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)
 o showPane(String)
Displays the specified pane at the top of the deck.

Constructors

 o DeckPaneManager
 public DeckPaneManager(String baseName,
                        String deckPaneName,
                        DataBean dataBeans[],
                        Container container) throws DisplayManagerException
Constructs a DeckPaneManager for the specified deck pane, using the specified container.

The default locale will be used to load the deck pane definition.

Parameters:
baseName - the resource name of the PDML document/resource bundle combination which defines the deck pane specification
paneName - the name of the deck pane, as specified on the DECKPANE tag in the PDML
dataBeans - a list of DataBeans which supply data to the deck pane (may be null)
container - the caller's container
Throws: DisplayManagerException
if an error was encountered accessing the deck pane definition
See Also:
DisplayManagerException
 o DeckPaneManager
 public DeckPaneManager(String baseName,
                        Locale locale,
                        String deckPaneName,
                        DataBean dataBeans[],
                        Container container) throws DisplayManagerException
Constructs a DeckPaneManager for the specified deck pane, using the specified container.

Parameters:
baseName - the resource name of the PDML document/resource bundle combination which defines the deck pane specification
locale - the desired locale to be used to load the deck pane definition
deckpaneName - the name of the deck pane, as specified on the DECKPANE tag in the PDML
dataBeans - a list of DataBeans which supply data to the deck pane (may be null)
container - the caller's container
Throws: DisplayManagerException
if an error was encountered accessing the deck pane definition
See Also:
DisplayManagerException
 o DeckPaneManager
 public DeckPaneManager(String baseName,
                        Locale locale,
                        String deckPaneName) throws DisplayManagerException
Constructs a DeckPaneManager object for the specified deck pane, and then serializes the deck pane definition. This constructor cannot be used to display the deck pane.

If a null locale is specified, the default locale will be used to load the deck pane definition. If resources for the default locale cannot be found, an attempt will be made to use the base resources for the deck pane.

Parameters:
baseName - the resource name of the PDML document/resource bundle combination which define the deck pane specification
locale - the desired locale to be used to load the deck pane definition (may be null)
deckPaneName - the name of the deck pane, as specified on the DECKPANE tag in the PDML
Throws: DisplayManagerException
if an error was encountered accessing or serializing the deck pane definition
See Also:
serialize

Methods

 o main
 public static void main(String args[])
Provides a command line interface to DeckPaneManager. See the class description.

 o serialize
 public void serialize() throws IOException
Serializes the deck pane definition. The filename of the serialized file will be of the form
 <deck pane name>_<locale string>.pdml.ser
 
where <deck pane name> is the name of the deck pane as specified on the DECKPANE tag in the PDML, and <locale string> consists of the ISO Language Code, ISO Country Code, and optional variant codes, each delimited by an underscore ("_") character.

Throws: IOException
if serialized file cannot be written
 o getPreferredSize
 public Dimension getPreferredSize()
Gets the preferred size of this deck pane.

Returns:
A dimension object indicating this deck pane's preferred size.
 o getTitle
 public String getTitle()
Returns the deck pane's title.

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

See Also:
PaneManager
 o activatePanel
 public void activatePanel()
Runs the activation handlers for the currently selected pane.

See Also:
PaneManager
 o getPaneNames
 public String[] getPaneNames()
Returns a list of the panes in the deck.

Returns:
an array of name strings which identify the panes
 o showPane
 public void showPane(String paneName)
Displays the specified pane at the top of the deck.

Parameters:
paneName - the name of the pane to be displayed
See Also:
PaneManager
 o getComponent
 public 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
See Also:
PaneManager
 o getComponentDescriptor
 public 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
See Also:
PaneManager
 o getDelegateManager
 public 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
See Also:
PaneManager
 o 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 DeckPaneManager is participating in an aggregate user interface.

Parameters:
mgr - the PaneManager with which the receiver is to be associated
See Also:
PaneManager
 o 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.
See Also:
PaneManager
 o 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.
See Also:
PaneManager
 o applyChanges
 public void applyChanges() throws IllegalUserDataException
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.

See Also:
PaneManager
 o prepareToCommit
 public void prepareToCommit(Vector preparedDataBeans)
Request the DataBeans which manage data for the panel 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
See Also:
PaneManager
 o commit
 public void commit(Vector committedDataBeans)
Commits the changes to data displayed on the pane. Calls the commit 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
See Also:
PaneManager
 o setFormatter
 public void setFormatter(String componentName,
                          DataFormatter formatter,
                          boolean required)
Sets the data formatter associated with 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
formatter - a reference to the data formatter to be associated with the component
required - whether a value is required to be entered
See Also:
DataFormatter
 o getFormatter
 public DataFormatter getFormatter(String componentName)
Returns the data formatter associated with 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 associated DataFormatter, or null if the component cannot be found
See Also:
DataFormatter
 o setHelpPath
 public void setHelpPath(String path)

All Packages  Class Hierarchy  This Package  Previous  Next  Index