public interface OptionToggle extends StylerItem
Modifier and Type | Interface and Description |
---|---|
static interface |
OptionToggle.Activate
Called when a dialog user selects an option from the menu
|
static class |
OptionToggle.ItemValueData
This class holds the data returned from
getItemValue() |
static interface |
OptionToggle.ValueChanged
Called when a dialog user clicks on the button or presses the spacebar when the button has keyboard focus.
|
StylerItem.ItemType
Modifier and Type | Method and Description |
---|---|
void |
addActivateHandler(OptionToggle.Activate activateevent,
boolean isDialogLaunchingEvent)
Registers activate callback.
|
void |
addValueChangedHandler(OptionToggle.ValueChanged valuechangedevent,
boolean isDialogLaunchingEvent)
Registers value change callback.
|
String[] |
getItems()
Returns the items
License requirements: None. |
OptionToggle.ItemValueData |
getItemValue()
Returns item value
License requirements: None. |
boolean |
getSensitivity()
Returns the sesitivity
License requirements: None. |
void |
setBitmaps(String[] bitmaps)
Set bitmaps
License requirements: None. |
void |
setDefaultAction()
Sets default action
License requirements: None. |
void |
setItems(String[] strListArray)
Sets items in the array
License requirements: None. |
void |
setItemValue(int subitemIndex,
boolean setCheck)
Sets item value
License requirements: None. |
void |
setLabel(String strLabel)
Sets label
License requirements: None. |
void |
setSensitivity(int subitemIndex,
boolean type)
Set the sesitivity
License requirements: None. |
void |
setVisibility(boolean type)
Sets the visibility
License requirements: None. |
boolean |
visibility()
Returns the visibility
License requirements: None. |
getItemType, initializeAttachment, isEqualTo, setAttachment
_value, dispose, printTestData, printTestData
void addActivateHandler(OptionToggle.Activate activateevent, boolean isDialogLaunchingEvent) throws NXException, RemoteException
UIStyler.Dialog#show
or UIStyler.Dialog#registerWithUiMenu
activateevent
- Callback for activate eventisDialogLaunchingEvent
- TRUE if dialog is going to launch, FALSE if notNXException
RemoteException
void addValueChangedHandler(OptionToggle.ValueChanged valuechangedevent, boolean isDialogLaunchingEvent) throws NXException, RemoteException
UIStyler.Dialog#show
or UIStyler.Dialog#registerWithUiMenu
valuechangedevent
- Callback for value changed eventisDialogLaunchingEvent
- TRUE if dialog is going to launch, FALSE if notNXException
RemoteException
void setBitmaps(String[] bitmaps) throws NXException, RemoteException
bitmaps
- An array of one or more bitmap filenames.
If all bitmaps for the option menu reside in the same file, specify an array of just one entry,
which contains the bitmap filename for this attribute. All existing choices for the option menu
remain intact when this attribute is set. Only the bitmaps are changed. Note that the number of
bitmaps must match the number of existing choices. NXException
RemoteException
void setLabel(String strLabel) throws NXException, RemoteException
strLabel
- Text to be set for the tool tip. NXException
RemoteException
void setItems(String[] strListArray) throws NXException, RemoteException
strListArray
- An array of new choices to be used for the dialog item.
Note that this removes all existing choices (both text and bitmaps). NXException
RemoteException
String[] getItems() throws NXException, RemoteException
NXException
RemoteException
void setItemValue(int subitemIndex, boolean setCheck) throws NXException, RemoteException
subitemIndex
- Zero-based index indicating the choice to be selected.
It must be in the range of existing choices.setCheck
- TRUE if set, FALSE if unset.NXException
RemoteException
OptionToggle.ItemValueData getItemValue() throws NXException, RemoteException
NXException
RemoteException
void setSensitivity(int subitemIndex, boolean type) throws NXException, RemoteException
subitemIndex
- If the entire dialog item should change to the new Sensitivity state,
set this field to UF_STYLER_NO_SUB_INDEX. If only one sub-item should change to the new sensitivity
state, set this field to its zero-based index.type
- TRUE if sensitive, FALSE if insensitiveNXException
RemoteException
boolean getSensitivity() throws NXException, RemoteException
NXException
RemoteException
void setVisibility(boolean type) throws NXException, RemoteException
type
- TRUE if visible, FALSE if invisibleNXException
RemoteException
boolean visibility() throws NXException, RemoteException
NXException
RemoteException
void setDefaultAction() throws NXException, RemoteException
NXException
RemoteException
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.