All Packages Class Hierarchy This Package Previous Next Index
Class com.sgi.sysadm.ui.event.GuideNavigationEvent
java.lang.Object
|
+----java.util.EventObject
|
+----com.sgi.sysadm.ui.event.GuideNavigationEvent
- public class GuideNavigationEvent
- extends EventObject
GuideNavigationEvent is sent to TaskControlListeners to indicate that
the user wants to navigate among the pages of a Guide.
-
FIRST_PAGE
- This pageCode indicates that the user has requested that the first
page of the guide be displayed.
-
LAST_PAGE
- This pageCode indicates that the user has requested that the last
page of the guide be displayed.
-
NEXT_PAGE
- This pageCode indicates that the user has requested that the next
page of the guide be displayed.
-
PREV_PAGE
- This pageCode indicates that the user has requested that the previous
page of the guide be displayed.
-
SPECIFIC_PAGE
- This pageCode indicates that the user has requested that a specific
page of the guide be displayed.
-
GuideNavigationEvent(TaskControlPanel, int)
- Constructor.
-
GuideNavigationEvent(TaskControlPanel, String)
- Constructor.
-
getControlPanel()
- Get the control panel that generated this event.
-
getPageCode()
- Get the code describing the navigation desired.
-
getPageName()
- Get the name of the page to which the user wants to navigate.
FIRST_PAGE
public static final int FIRST_PAGE
- This pageCode indicates that the user has requested that the first
page of the guide be displayed.
LAST_PAGE
public static final int LAST_PAGE
- This pageCode indicates that the user has requested that the last
page of the guide be displayed.
NEXT_PAGE
public static final int NEXT_PAGE
- This pageCode indicates that the user has requested that the next
page of the guide be displayed.
PREV_PAGE
public static final int PREV_PAGE
- This pageCode indicates that the user has requested that the previous
page of the guide be displayed.
SPECIFIC_PAGE
public static final int SPECIFIC_PAGE
- This pageCode indicates that the user has requested that a specific
page of the guide be displayed. The pageName can be retrieved via
GuideNavigationEvent.getPageName().
GuideNavigationEvent
public GuideNavigationEvent(TaskControlPanel controlPanel,
int pageCode)
- Constructor.
- Parameters:
- controlPanel - The control panel generating the navigation event.
- pageCode - The code describing the navigation desired.
GuideNavigationEvent
public GuideNavigationEvent(TaskControlPanel controlPanel,
String pageName)
- Constructor.
- Parameters:
- controlPanel - The control panel generating the navigation event.
- pageName - The name of the specific page to which the user wants
to navigate. pageCode will be set to SPECIFIC_PAGE.
getControlPanel
public TaskControlPanel getControlPanel()
- Get the control panel that generated this event.
- Returns:
- The control panel that generated this event.
getPageCode
public int getPageCode()
- Get the code describing the navigation desired.
- Returns:
- The code describing the navigation desired.
getPageName
public String getPageName()
- Get the name of the page to which the user wants to navigate.
- Returns:
- The name of the page to which the user wants to navigate
if this is a SPECIFIC_PAGE event, null otherwise.
All Packages Class Hierarchy This Package Previous Next Index