public interface Wizard extends UIBlock
Modifier and Type | Interface and Description |
---|---|
static interface |
Wizard.IsStepOkayCallback
The IsStepOkay callback allows the client to notify the Wizard that the step is okay
or not.
|
static interface |
Wizard.OnMenuCallback
The OnMenu callback notifies a client prior to creating the popup menu in the Task
Navigator.
|
static interface |
Wizard.OnMenuSelectionCallback
The OnMenuSelection callback notifies a client of the menu item selection on the popup menu
in the Task Navigator.
|
static interface |
Wizard.OnSubNodeCallback
The OnSubNode callback notifies a client of an action performed
on a sub-node in the Wizard Task Navigator.
|
static interface |
Wizard.StepNotifyPostCallback
The StepNotifyPost callback notifies a client after navigating to the next step
in the Wizard.
|
static interface |
Wizard.StepNotifyPreCallback
The StepNotifyPre callback notifies a client before navigating to the next step
in the Wizard.
|
static class |
Wizard.SubNodeAction
Specifies the type of action performed on a sub-node in the Wizard Task Navigator.
|
static class |
Wizard.TaskNavigatorItem
Specifies an item in the Task Navigator.
|
Modifier and Type | Method and Description |
---|---|
TreeListMenu |
createMenu()
Creates a popup menu.
|
int |
createStepSubNode(int step,
String text,
String bitmap,
boolean showCheckBox,
boolean checkBoxChecked)
Create a sub-node for a step in the Task Navigator.
|
int |
currentStep()
Returns the CurrentStep.
|
String[] |
getStepBannerBitmaps()
Gets the StepBannerBitmaps.
|
String[] |
getStepBitmaps()
Gets the StepBitmaps.
|
String[] |
getStepCues()
Gets the StepCues.
|
String[] |
getStepText()
Gets the StepText.
|
boolean |
highQualityBitmap()
Returns the HighQualityBitmap.
|
boolean |
localize()
Returns the Localize.
|
PropertyList |
members()
Returns the Members
License requirements: None. |
void |
removeStepSubNode(int subNodeId)
Remove a sub-node in the Task Navigator.
|
void |
setCurrentStep(int currentStep)
License requirements: None. |
void |
setHighQualityBitmap(boolean highQuality)
License requirements: None. |
void |
setIsStepOkayHandler(Wizard.IsStepOkayCallback cb)
Sets the IsStepOkay handler.
|
void |
setLocalize(boolean localize)
License requirements: None. |
void |
setMenu(TreeListMenu menu)
Set the menu items for the popup menu for a step, sub-node or the background
in the Task Navigator.
|
void |
setOnMenuHandler(Wizard.OnMenuCallback cb)
Sets the OnMenu handler.
|
void |
setOnMenuSelectionHandler(Wizard.OnMenuSelectionCallback cb)
Sets the OnMenuSelection handler.
|
void |
setOnSubNodeHandler(Wizard.OnSubNodeCallback cb)
Sets the OnSubNode handler.
|
void |
setShowTaskNavigator(boolean show)
License requirements: None. |
void |
setStepBannerBitmaps(String[] bitmaps)
Sets the StepBannerBitmaps.
|
void |
setStepBitmaps(String[] bitmaps)
Sets the StepBitmaps.
|
void |
setStepCues(String[] cues)
Sets the StepCues.
|
void |
setStepNotifyPostHandler(Wizard.StepNotifyPostCallback cb)
Sets the StepNotifyPost handler.
|
void |
setStepNotifyPreHandler(Wizard.StepNotifyPreCallback cb)
Sets the StepNotifyPre handler.
|
void |
setStepText(String[] text)
Sets the StepText.
|
boolean |
showTaskNavigator()
Returns the ShowTaskNavigator.
|
enable, expanded, focus, getProperties, group, label, name, setEnable, setExpanded, setGroup, setLabel, setShow, show, type
printTestData, printTestData, tag, tagValue
int createStepSubNode(int step, String text, String bitmap, boolean showCheckBox, boolean checkBoxChecked) throws NXException, RemoteException
step
- The step to add a sub-node.text
- Text for the sub-node.bitmap
- Optional bitmap for the sub-node.showCheckBox
- Associate an optional check box with the sub-nodecheckBoxChecked
- The initial state of the check box.NXException
RemoteException
void removeStepSubNode(int subNodeId) throws NXException, RemoteException
subNodeId
- The sub-node id.NXException
RemoteException
TreeListMenu createMenu() throws NXException, RemoteException
BlockStyler.Wizard#setMenu
to set
the created menu. See the BlockStyler.TreeListMenu
for
information on creating a menu.
NXException
RemoteException
void setMenu(TreeListMenu menu) throws NXException, RemoteException
BlockStyler.TreeListMenu
for
information on creating a menu.
menu
- NXException
RemoteException
void setStepNotifyPreHandler(Wizard.StepNotifyPreCallback cb) throws NXException, RemoteException
cb
- NXException
RemoteException
void setStepNotifyPostHandler(Wizard.StepNotifyPostCallback cb) throws NXException, RemoteException
cb
- NXException
RemoteException
void setIsStepOkayHandler(Wizard.IsStepOkayCallback cb) throws NXException, RemoteException
cb
- NXException
RemoteException
void setOnSubNodeHandler(Wizard.OnSubNodeCallback cb) throws NXException, RemoteException
cb
- NXException
RemoteException
void setOnMenuHandler(Wizard.OnMenuCallback cb) throws NXException, RemoteException
cb
- NXException
RemoteException
void setOnMenuSelectionHandler(Wizard.OnMenuSelectionCallback cb) throws NXException, RemoteException
cb
- NXException
RemoteException
int currentStep() throws NXException, RemoteException
NXException
RemoteException
void setCurrentStep(int currentStep) throws NXException, RemoteException
currentStep
- NXException
RemoteException
boolean highQualityBitmap() throws NXException, RemoteException
NXException
RemoteException
void setHighQualityBitmap(boolean highQuality) throws NXException, RemoteException
highQuality
- NXException
RemoteException
boolean localize() throws NXException, RemoteException
NXException
RemoteException
void setLocalize(boolean localize) throws NXException, RemoteException
localize
- NXException
RemoteException
PropertyList members() throws NXException, RemoteException
NXException
RemoteException
boolean showTaskNavigator() throws NXException, RemoteException
NXException
RemoteException
void setShowTaskNavigator(boolean show) throws NXException, RemoteException
show
- NXException
RemoteException
String[] getStepBannerBitmaps() throws NXException, RemoteException
NXException
RemoteException
void setStepBannerBitmaps(String[] bitmaps) throws NXException, RemoteException
bitmaps
- NXException
RemoteException
String[] getStepBitmaps() throws NXException, RemoteException
NXException
RemoteException
void setStepBitmaps(String[] bitmaps) throws NXException, RemoteException
bitmaps
- NXException
RemoteException
String[] getStepCues() throws NXException, RemoteException
NXException
RemoteException
void setStepCues(String[] cues) throws NXException, RemoteException
cues
- NXException
RemoteException
String[] getStepText() throws NXException, RemoteException
NXException
RemoteException
void setStepText(String[] text) throws NXException, RemoteException
text
- NXException
RemoteException
Copyright 2016 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.