All Packages Class Hierarchy This Package Previous Next Index
Class com.sgi.sysadm.ui.TaskControlPanel
java.lang.Object
|
+----java.awt.Component
|
+----java.awt.Container
|
+----javax.swing.JComponent
|
+----javax.swing.JPanel
|
+----com.sgi.sysadm.ui.TaskControlPanel
- public class TaskControlPanel
- extends JPanel
TaskControlPanel is a user interface for driving a Task. It allows users
to initiate a Task operation, cancel a Task, request help, toggle
between the Form and Guide interface (if both are present), and navigate
through the pages of the Guide interface (when it is present). It
communicates with the Task via the TaskControlListener interface.
-
BUTTON_ARROW_SPACING
- The property TaskControlPanel.buttonArrowSpacing is the
spacing in points between the arrow icon and the text in the
"Next" and "Prev" buttons.
-
CANCEL_BUTTON_KEY_CODE
- The property TaskControlPanel.cancelButtonKeyCode is the
key code of the accelerator for the "Cancel" button.
-
CANCEL_BUTTON_LABEL
- The property TaskControlPanel.cancelButtonLabel is a String that
is displayed on the cancel button.
-
FORM_BUTTON_LABEL
- The property TaskControlPanel.formButtonLabel is a String that
is displayed on the interface toggle button when the button will
toggle the interface from Guide mode to Form mode (in other
words, when the Guide is the current interface).
-
GUIDE_BUTTON_LABEL
- The property TaskControlPanel.guideButtonLabel is the String that
is displayed on the interface toggle button when the button
will toggle the interface from Form mode to Guide mode (in
other words, when the Form is the current interface).
-
HELP_BUTTON_LABEL
- The property TaskControlPanel.helpButtonLabel is a String that
is displayed on the help button.
-
MARGIN_BOTTOM
- The property TaskControlPanel.marginBottom is the distance,
in points, between the bottom of the control panel and its
contents.
-
MARGIN_LEFT
- The property TaskControlPanel.marginLeft is the distance,
in points, between the left side of the control panel and its
contents.
-
MARGIN_RIGHT
- The property TaskControlPanel.marginRight is the distance,
in points, between the right side of the control panel and its
contents.
-
MARGIN_TOP
- The property TaskControlPanel.marginTop is the distance,
in points, between the top of the control panel and its
contents.
-
MIN_BUTTON_SPACING
- The property TaskControlPanel.minButtonSpacing is the
minimum distance, in points, between any two buttons in the
TaskControlPanel.
-
NEXT_BUTTON_KEY_CODE
- The property TaskControlPanel.nextButtonKeyCode is the
key code of the accelerator for the "Next" button.
-
NEXT_BUTTON_LABEL
- The property TaskControlPanel.nextButtonLabel is a String that
is displayed on the next button when the Guide is displayed.
-
OK_BUTTON_KEY_CODE
- The property TaskControlPanel.okButtonKeyCode is the
key code of the accelerator for the "OK" button.
-
OK_BUTTON_LABEL
- The property TaskControlPanel.okButtonLabel is a String that
is displayed on the OK button.
-
PREV_BUTTON_KEY_CODE
- The property TaskControlPanel.prevButtonKeyCode is the
key code of the accelerator for the "Prev" button.
-
PREV_BUTTON_LABEL
- The property TaskControlPanel.prevButtonLabel is a String that
is displayed on the prev button when the Guide is displayed.
-
TaskControlPanel(ResourceStack)
- Constructor.
-
addControlListener(TaskControlListener)
- Register interest in TaskControlPanel events.
-
removeControlListener(TaskControlListener)
- Unregister interest in TaskControlPanel events.
-
setCancelButtonEnabled(boolean)
- Make the cancel button visible and enabled or invisible and disabled.
-
setFormMode()
- Tell the control panel that it should go into Form control mode.
-
setGuideMode()
- Tell the control panel to go into Guide control mode.
-
setInterfaceToggleEnabled(boolean)
- Enable or disable the Form/Guide toggle components
-
setNextEnabled(boolean)
- Enable or disable the Next components.
-
setOKEnabled(boolean)
- Enable or disable the OK components.
-
setPrevEnabled(boolean)
- Enable or disable the Prev components.
GUIDE_BUTTON_LABEL
public static final String GUIDE_BUTTON_LABEL
- The property TaskControlPanel.guideButtonLabel is the String that
is displayed on the interface toggle button when the button
will toggle the interface from Form mode to Guide mode (in
other words, when the Form is the current interface). The
interface toggle button will only be displayed the Task has
both a Form and a Guide.
FORM_BUTTON_LABEL
public static final String FORM_BUTTON_LABEL
- The property TaskControlPanel.formButtonLabel is a String that
is displayed on the interface toggle button when the button will
toggle the interface from Guide mode to Form mode (in other
words, when the Guide is the current interface). The
interface toggle button will only be displayed the Task has
both a Form and a Guide.
PREV_BUTTON_LABEL
public static final String PREV_BUTTON_LABEL
- The property TaskControlPanel.prevButtonLabel is a String that
is displayed on the prev button when the Guide is displayed.
NEXT_BUTTON_LABEL
public static final String NEXT_BUTTON_LABEL
- The property TaskControlPanel.nextButtonLabel is a String that
is displayed on the next button when the Guide is displayed.
OK_BUTTON_LABEL
public static final String OK_BUTTON_LABEL
- The property TaskControlPanel.okButtonLabel is a String that
is displayed on the OK button.
CANCEL_BUTTON_LABEL
public static final String CANCEL_BUTTON_LABEL
- The property TaskControlPanel.cancelButtonLabel is a String that
is displayed on the cancel button.
HELP_BUTTON_LABEL
public static final String HELP_BUTTON_LABEL
- The property TaskControlPanel.helpButtonLabel is a String that
is displayed on the help button.
MIN_BUTTON_SPACING
public static final String MIN_BUTTON_SPACING
- The property TaskControlPanel.minButtonSpacing is the
minimum distance, in points, between any two buttons in the
TaskControlPanel.
BUTTON_ARROW_SPACING
public static final String BUTTON_ARROW_SPACING
- The property TaskControlPanel.buttonArrowSpacing is the
spacing in points between the arrow icon and the text in the
"Next" and "Prev" buttons.
MARGIN_TOP
public static final String MARGIN_TOP
- The property TaskControlPanel.marginTop is the distance,
in points, between the top of the control panel and its
contents.
MARGIN_LEFT
public static final String MARGIN_LEFT
- The property TaskControlPanel.marginLeft is the distance,
in points, between the left side of the control panel and its
contents.
MARGIN_BOTTOM
public static final String MARGIN_BOTTOM
- The property TaskControlPanel.marginBottom is the distance,
in points, between the bottom of the control panel and its
contents.
MARGIN_RIGHT
public static final String MARGIN_RIGHT
- The property TaskControlPanel.marginRight is the distance,
in points, between the right side of the control panel and its
contents.
PREV_BUTTON_KEY_CODE
public static final String PREV_BUTTON_KEY_CODE
- The property TaskControlPanel.prevButtonKeyCode is the
key code of the accelerator for the "Prev" button.
OK_BUTTON_KEY_CODE
public static final String OK_BUTTON_KEY_CODE
- The property TaskControlPanel.okButtonKeyCode is the
key code of the accelerator for the "OK" button.
CANCEL_BUTTON_KEY_CODE
public static final String CANCEL_BUTTON_KEY_CODE
- The property TaskControlPanel.cancelButtonKeyCode is the
key code of the accelerator for the "Cancel" button.
NEXT_BUTTON_KEY_CODE
public static final String NEXT_BUTTON_KEY_CODE
- The property TaskControlPanel.nextButtonKeyCode is the
key code of the accelerator for the "Next" button.
TaskControlPanel
public TaskControlPanel(ResourceStack rs)
- Constructor.
All components are created here. TaskControlPanel is
visible by default.
- Parameters:
- rs - ResourceStack that defines TaskControlPanel properties.
addControlListener
public void addControlListener(TaskControlListener listener)
- Register interest in TaskControlPanel events.
- Parameters:
- listener - Object interested in receiving events.
removeControlListener
public void removeControlListener(TaskControlListener listener)
- Unregister interest in TaskControlPanel events.
- Parameters:
- listener - Object no longer interested in receiving events.
setFormMode
public void setFormMode()
- Tell the control panel that it should go into Form control mode.
Guide navigation features will be hidden.
If the Task has only a Form, the Task base class will call
TaskControlPanel.setInterfaceToggleEnabled(false) to disable
the Form/Guide toggle components. Those components are enabled
by default.
setGuideMode
public void setGuideMode()
- Tell the control panel to go into Guide control mode.
Guide navigation features will be displayed.
If the Task has only a Guide, the Task base class will call
TaskControlPanel.setInterfaceToggleEnabled(false) to disable
the Form/Guide toggle components. Those components are enabled
by default.
setPrevEnabled
public void setPrevEnabled(boolean enable)
- Enable or disable the Prev components.
- Parameters:
- enable - true to enable the Prev components,
false to disable them.
setNextEnabled
public void setNextEnabled(boolean enable)
- Enable or disable the Next components.
- Parameters:
- enable - true to enable the Next components,
false to disable them.
setOKEnabled
public void setOKEnabled(boolean enable)
- Enable or disable the OK components.
- Parameters:
- enable - true to enable the OK components,
false to disable them.
setInterfaceToggleEnabled
public void setInterfaceToggleEnabled(boolean enable)
- Enable or disable the Form/Guide toggle components
- Parameters:
- enable - true to enable the Form/Guide toggle components,
false to disable them.
setCancelButtonEnabled
public void setCancelButtonEnabled(boolean enable)
- Make the cancel button visible and enabled or invisible and disabled.
The cancel button defaults to being visible and enabled.
- Parameters:
- enable - true to show the cancel button and enable it,
false to hide the cancel button and disable it.
All Packages Class Hierarchy This Package Previous Next Index