All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.sgi.sysadm.ui.TaskPage

java.lang.Object
   |
   +----java.awt.Component
           |
           +----java.awt.Container
                   |
                   +----javax.swing.JComponent
                           |
                           +----javax.swing.JPanel
                                   |
                                   +----com.sgi.sysadm.ui.RPanel
                                           |
                                           +----com.sgi.sysadm.ui.TaskPage

public class TaskPage
extends RPanel
A panel that contains a page for a Task. The overall look is as follows: The upper-left corner of the panel contains an icon. To the right of the Icon is the title of the Task. Below the the title is a RichTextArea known as the IntroText. Below the IntroText are the task components that make up the functional part of the TaskPage.

When adding the task components to the TaskPage, you can choose to add them as normal components or as optional components. Optional components use an OptionalLinkLabel for their label to distinguish them from the non-optional components that use LinkLabels.

The task components are arranged in a LabelComponentPanel. Several of the methods to add task components take a name parameter. This name is used to name the component when it is added to the LabelComponentPanel. There are many resources you can set based on the component's name to control the way that the task components and their labels are laid out in the LabelComponentPanel. See the LabelComponentPanel documentation for information about the resources.

In the case of the addTaskComponent and addOptionalTaskComponent methods that takes a component and a name, the name is also used as the name argument to the LinkLabel or OptionalLinkLabel that is created for use as a label. See the LinkLabel documentation on how to use that name to set resources to control the text displayed in the LinkLable and the glossary entry that the LinkLabel will launch.

See Also:
RichTextArea, OptionalLinkLabel, LinkLabel, LabelComponentPanel

Constructor Index

 o TaskPage(ResourceStack)
Construct a TaskPage.

Method Index

 o addOptionalTaskComponent(Component)
Adds an optional component but no label to the TaskPage
 o addOptionalTaskComponent(Component, Component)
Adds an optional component and a label to the TaskPage.
 o addOptionalTaskComponent(Component, String)
Adds a component and a label to the TaskPage.
 o addOptionalTaskComponent(Component, String, Component)
Adds an optional component and a label to the TaskPage.
 o addTaskComponent(Component)
Adds a component but no label to the TaskPage
 o addTaskComponent(Component, Component)
Adds a component and a label to the TaskPage.
 o addTaskComponent(Component, String)
Adds a component and a label to the TaskPage.
 o addTaskComponent(Component, String, Component)
Adds a component and a label to the TaskPage.
 o removeTaskComponent(Component)
Removes a component and any label associated with it.
 o setIcon(Component)
Adds an Component to the TaskPage in the icon's spot.
 o setIcon(Icon)
Adds an Icon the the TaskPage in the icon's spot
 o setIcon(String)
Adds an Icon to the TaskPage, based on the name of a resource describing the icon.
 o setIntroText(Component)
Adds the introText to the TaskPage
 o setTitle(Component)
Adds a component to the title's spot on the TaskPage.
 o setTitle(String)
Adds a title to the TaskPage

Constructors

 o TaskPage
 public TaskPage(ResourceStack resourceStack)
Construct a TaskPage. resourceStack specifies resources for the TaskPage.

Parameters:
resourceStack - Specifies resources for the TaskPage.

Methods

 o setIcon
 public void setIcon(Component icon)
Adds an Component to the TaskPage in the icon's spot.

Parameters:
icon - The component to place in the icon's spot. Pass a null to remove the current icon.
 o setIcon
 public void setIcon(Icon icon)
Adds an Icon the the TaskPage in the icon's spot

Parameters:
icon - The Icon to place in the icon's spot.
 o setIcon
 public void setIcon(String iconRes)
Adds an Icon to the TaskPage, based on the name of a resource describing the icon. If the resource is not found, a MissingResourceException will be thrown.

Parameters:
iconRes - The resource naming the FtrIcon or ImageIcon to add.
 o setTitle
 public void setTitle(String title)
Adds a title to the TaskPage

Parameters:
title - The title for the page. Pass the empty string to remove the title.
 o setTitle
 public void setTitle(Component title)
Adds a component to the title's spot on the TaskPage.

Parameters:
title - The title for the page. Pass a null to remove the title.
 o setIntroText
 public void setIntroText(Component intro)
Adds the introText to the TaskPage

Parameters:
intro - The IntroText
 o addTaskComponent
 public void addTaskComponent(Component component)
Adds a component but no label to the TaskPage

Parameters:
component - The component to add
 o addTaskComponent
 public RichTextComponent addTaskComponent(Component component,
                                           String name)
Adds a component and a label to the TaskPage. A LinkLabel will be created to display the label.

Parameters:
component - The component to add
name - The name of component. This will be passed as the name argument to both LinkLabel and LabelComponentPanel.
Returns:
A RichTextComponent that is the label that was created
See Also:
LinkLabel, LabelComponentPanel
 o addTaskComponent
 public void addTaskComponent(Component component,
                              Component label)
Adds a component and a label to the TaskPage. Since no name is passed, the LabelComponentPanel will use a default layout when adding the component and label to the layout.

Parameters:
component - The component to add
label - The label that describes this component
 o addTaskComponent
 public void addTaskComponent(Component component,
                              String name,
                              Component label)
Adds a component and a label to the TaskPage.

Parameters:
component - The component to add
name - The name of this component. This will be passed as the name argument to LabelComponentPanel, and can be used to create resources that control the layout of the component and its label.
label - The label that describes this component
See Also:
LabelComponentPanel
 o addOptionalTaskComponent
 public void addOptionalTaskComponent(Component component)
Adds an optional component but no label to the TaskPage

Parameters:
component - The component to add
 o addOptionalTaskComponent
 public RichTextComponent addOptionalTaskComponent(Component component,
                                                   String name)
Adds a component and a label to the TaskPage. An OptionalLinkLabel will be created to display the label.

Parameters:
component - The component to add
name - The name of this component. This will be passed as the name argument to both OptionalLinkLabel and LabelComponentPanel.
Returns:
A RichTextComponent that is the label that was created
 o addOptionalTaskComponent
 public void addOptionalTaskComponent(Component component,
                                      Component label)
Adds an optional component and a label to the TaskPage. Since no name is passed, the LabelComponentPanel will use a default layout when adding the component and label to the layout.

Parameters:
component - The component to add
label - The label that describes this component
 o addOptionalTaskComponent
 public void addOptionalTaskComponent(Component component,
                                      String name,
                                      Component label)
Adds an optional component and a label to the TaskPage.

Parameters:
component - The component to add
name - The name of this component. This will be passed as the name argument to LabelComponentPanel, and can be used to create resources that control the layout of the component and its label.
label - The label that describes this component
 o removeTaskComponent
 public void removeTaskComponent(Component component)
Removes a component and any label associated with it.

Parameters:
component - The component to remove

All Packages  Class Hierarchy  This Package  Previous  Next  Index