All Packages Class Hierarchy This Package Previous Next Index
Class com.sgi.sysadm.ui.Form
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
|
+----com.sgi.sysadm.ui.Form
- public class Form
- extends TaskPage
Form is the base class for the Form interface of a Task. In
typical usage, a subclass overrides Form.createUI() to add
Task-specific components.
For more information about writing Tasks in Rhino, see the
How to write a Task
tutorial.
- See Also:
- Task
-
DYNAMIC_SIZE
- The property Form.dynamicSize is a Boolean that
specifies whether or not the Form should determine its height
dynamically based on Task.TASK_WIDTH_IN_POINTS.
-
ICON
- The property Form.icon describes the
CLASSPATH relative
name of the icon image
file to be used on the Form page.
-
INTRO_TEXT
- The property Form.introText is a String containing
the introductory text for the Form.
-
TITLE
- The property Form.title is a string that is displayed at the
top of the Form next to the Form icon.
-
Form(TaskContext)
- Constructor.
-
createUI()
- Called by the Form base class when the Form interface becomes
visible for the first time.
-
showForm()
- Called by the Task base class each time the Form interface is to be
displayed (for example when the User switches from Guide to
Form).
ICON
public static final String ICON
- The property Form.icon describes the
CLASSPATH relative
name of the icon image
file to be used on the Form page. This property is used by
Form.createUI() to load the Form page icon.
A default value for this property is provided in TaskContextP.properties
and it should be overridden in either {package}.PackageP.properties or
{package}.{taskname}P.properties.
TITLE
public static final String TITLE
- The property Form.title is a string that is displayed at the
top of the Form next to the Form icon. A default value for this
property is provided in TaskContextP.properties and it should be
overridden in {package}.{taskname}P.properties.
INTRO_TEXT
public static final String INTRO_TEXT
- The property Form.introText is a String containing
the introductory text for the Form. If this property exists,
the text will be displayed in a RichTextArea at the top of the
Form.
- See Also:
- RichTextArea
DYNAMIC_SIZE
public static final String DYNAMIC_SIZE
- The property Form.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.
Form
public Form(TaskContext taskContext)
- Constructor.
- Parameters:
- taskContext - Context of task.
createUI
protected void createUI()
- Called by the Form base class when the Form interface becomes
visible for the first time. Form.createUI() sets the title of
the Form page using the property Form.TITLE and sets the icon
of the Form page using the property Form.ICON.
Subclasses should override this method to create Task-specific
Form interface components. Call super.createUI() before
creating any components to ensure that the Form title and icon
appear at the top of the Form.
showForm
public void showForm()
- Called by the Task base class each time the Form interface is to be
displayed (for example when the User switches from Guide to
Form). The first time Form.showForm() is called, Form.createUI()
is called to create the user interface components. Form.showForm()
enables the OK button and sets the Task title using
TaskContext.getTitleString().
All Packages Class Hierarchy This Package Previous Next Index