All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.sgi.sysadm.ui.Guide

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

public abstract class Guide
extends JPanel
Guide is the base class for the Guide interface of a Task. In typical usage, a subclass implements registerPages(), in which the initial GuidePages of the Guide are created and registered with the Guide base class using Guide.appendPage(). Subclasses and TaskDataVerifiers can also use Guide.removePage() and Guide.insertPage() at any time to change the list of GuidePages based on User input.

The Guide base class is responsible for maintaining the list of GuidePages, and responding to Guide navigation events by calling the appropriate TaskDataVerifiers and changing the GuidePage that is currently displayed.

For more information about writing Tasks in Rhino, see the How to write a Task tutorial.

See Also:
Task, TaskDataVerifier

Variable Index

 o DYNAMIC_SIZE
The resource Guide.dynamicSize is a Boolean that specifies whether or not the Form should determine its height dynamically based on Task.TASK_WIDTH_IN_POINTS.
 o ICON
The property Guide.icon describes the CLASSPATH relative name of the icon image file to be used on any GuidePage that does not have its own icon (specified via the property GuidePage.icon).
 o NEXT_PAGE_CANCEL
The resource Guide.nextPageError.cancel is a String that is displayed as the label for the button on the dialog that appears when a user attemps to go to the next page, but the verifiers fail.
 o NEXT_PAGE_CONTINUE
The resource Guide.nextPageError.continue is a String that is displayed as the label for the button on the dialog that appears when a user attemps to go to the next page, but the verifiers fail.
 o TITLE_FORMAT
The property Guide.titleFormat is a format string that includes three arguments: {0} for the task title string (see the property Task.titleFormat), {1} for the page number of the currently-displayed GuidePage, and {2} for the total number of GuidePages currently in the Guide.

Constructor Index

 o Guide(TaskContext)
Constructor.

Method Index

 o appendPage(GuidePage)
Append a GuidePage to the ordered list of GuidePages.
 o getCurrentPage()
Get the current page of the Guide.
 o insertPage(GuidePage, GuidePage)
Insert a GuidePage into the ordered list of GuidePages.
 o registerPages()
Called by the base class to request that the subclass create and register the initial GuidePages via appendPage().
 o removePage(GuidePage)
Remove a GuidePage from the ordered list of GuidePages.
 o showGuide()
Tell the Guide to show its current page.

Variables

 o TITLE_FORMAT
 public static final String TITLE_FORMAT
The property Guide.titleFormat is a format string that includes three arguments: {0} for the task title string (see the property Task.titleFormat), {1} for the page number of the currently-displayed GuidePage, and {2} for the total number of GuidePages currently in the Guide. The format string is used by Guide.showGuide() to format the Task title associated with the Guide interface each time a new GuidePage is displayed.

A default value for this property is provided in TaskContextP.properties and it may be overridden in either {package}.PackageP.properties or {package}.{taskname}P.properties.

 o ICON
 public static final String ICON
The property Guide.icon describes the CLASSPATH relative name of the icon image file to be used on any GuidePage that does not have its own icon (specified via the property GuidePage.icon). The property is used by GuidePage.createUI() to load the GuidePage icon.

A default value for this property is provided in TaskContextP.properties and it may be overridden in either {package}.PackageP.properties or {package}.{taskname}P.properties.

 o DYNAMIC_SIZE
 public static final String DYNAMIC_SIZE
The resource Guide.dynamicSize is a Boolean that specifies whether or not the Form should determine its height dynamically based on Task.TASK_WIDTH_IN_POINTS. If false, the height is based on Task.TASK_HEIGHT_IN_POINTS if present, or the golden ratio.

 o NEXT_PAGE_CANCEL
 public static final String NEXT_PAGE_CANCEL
The resource Guide.nextPageError.cancel is a String that is displayed as the label for the button on the dialog that appears when a user attemps to go to the next page, but the verifiers fail. This label is for the button that returns them to the page they were on.

 o NEXT_PAGE_CONTINUE
 public static final String NEXT_PAGE_CONTINUE
The resource Guide.nextPageError.continue is a String that is displayed as the label for the button on the dialog that appears when a user attemps to go to the next page, but the verifiers fail. This label is for the button that ignores the error and turns the page anyway.

Constructors

 o Guide
 public Guide(TaskContext taskContext)
Constructor.

Parameters:
taskContext - Context of the task.

Methods

 o showGuide
 public void showGuide()
Tell the Guide to show its current page. The first time this is called, the subclass will be asked to register the initial set of GuidePages. However, the interface components for each GuidePage will not be created until its showPage() method is called.

The TaskControlPanel will be updated based on which page of the Guide is shown. The Task window title will be generated using the property Guide.TITLE_FORMAT and TaskContext.getTitleString().

See Also:
TaskControlPanel
 o registerPages
 public abstract void registerPages()
Called by the base class to request that the subclass create and register the initial GuidePages via appendPage().

 o appendPage
 public void appendPage(GuidePage page)
Append a GuidePage to the ordered list of GuidePages.

Parameters:
page - The GuidePage to append to Guide.
 o insertPage
 public void insertPage(GuidePage page,
                        GuidePage previousPage)
Insert a GuidePage into the ordered list of GuidePages.

Parameters:
page - The GuidePage to insert into the Guide.
previousPage - The GuidePage which should preceed page in the ordered list of GuidePages. null if page should be the first page.
 o removePage
 public void removePage(GuidePage page)
Remove a GuidePage from the ordered list of GuidePages.

Parameters:
page - The GuidePage to be removed from the Guide.
 o getCurrentPage
 public GuidePage getCurrentPage()
Get the current page of the Guide.

Returns:
The current page of the Guide.

All Packages  Class Hierarchy  This Package  Previous  Next  Index