nxopen.uistyler

Interface OptionToggle

All Superinterfaces:

Remote, StylerItem, TransientObject

public interface OptionToggle
extends StylerItem

Represents a OptionToggle for UI Styler .
Created in NX5.0.0

Nested Class Summary

Nested Classes

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.

Nested classes/interfaces inherited from interface nxopen.uistyler.StylerItem

StylerItem.ItemType

Method Summary

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.

Methods inherited from interface nxopen.uistyler.StylerItem

getItemType, initializeAttachment, isEqualTo, setAttachment

Methods inherited from interface nxopen.TransientObject

_value, dispose, printTestData, printTestData

Method Detail

addActivateHandler

void addActivateHandler(OptionToggle.Activate activateevent,
                        boolean isDialogLaunchingEvent)
                 throws NXException,
                        RemoteException

Registers activate callback. This method should be called before calling Dialog.show() or Dialog.registerWithUiMenu(boolean)
License requirements: None.

Created in NX5.0.0

Parameters:

activateevent - Callback for activate event

isDialogLaunchingEvent - TRUE if dialog is going to launch, FALSE if not

Throws:

NXException

RemoteException

addValueChangedHandler

void addValueChangedHandler(OptionToggle.ValueChanged valuechangedevent,
                            boolean isDialogLaunchingEvent)
                     throws NXException,
                            RemoteException

Registers value change callback. This method should be called before calling Dialog.show() or Dialog.registerWithUiMenu(boolean)
License requirements: None.

Created in NX5.0.0

Parameters:

valuechangedevent - Callback for value changed event

isDialogLaunchingEvent - TRUE if dialog is going to launch, FALSE if not

Throws:

NXException

RemoteException

setBitmaps

void setBitmaps(String[] bitmaps)
         throws NXException,
                RemoteException

Set bitmaps
License requirements: None.

Created in NX5.0.0

Parameters:

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.

Throws:

NXException

RemoteException

setLabel

void setLabel(String strLabel)
       throws NXException,
              RemoteException

Sets label
License requirements: None.

Created in NX5.0.0

Parameters:

strLabel - Text to be set for the tool tip.

Throws:

NXException

RemoteException

setItems

void setItems(String[] strListArray)
       throws NXException,
              RemoteException

Sets items in the array
License requirements: None.

Created in NX5.0.0

Parameters:

strListArray - An array of new choices to be used for the dialog item. Note that this removes all existing choices (both text and bitmaps).

Throws:

NXException

RemoteException

getItems

String[] getItems()
           throws NXException,
                  RemoteException

Returns the items
License requirements: None.

Created in NX5.0.0

Returns:

An array of items

Throws:

NXException

RemoteException

setItemValue

void setItemValue(int subitemIndex,
                  boolean setCheck)
           throws NXException,
                  RemoteException

Sets item value
License requirements: None.

Created in NX5.0.0

Parameters:

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.

Throws:

NXException

RemoteException

getItemValue

OptionToggle.ItemValueData getItemValue()
                                 throws NXException,
                                        RemoteException

Returns item value
License requirements: None.

Created in NX5.0.0

Returns:

a ItemValueData object

Throws:

NXException

RemoteException

setSensitivity

void setSensitivity(int subitemIndex,
                    boolean type)
             throws NXException,
                    RemoteException

Set the sesitivity
License requirements: None.

Created in NX5.0.0

Parameters:

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 insensitive

Throws:

NXException

RemoteException

getSensitivity

boolean getSensitivity()
                throws NXException,
                       RemoteException

Returns the sesitivity
License requirements: None.

Created in NX5.0.0

Throws:

NXException

RemoteException

setVisibility

void setVisibility(boolean type)
            throws NXException,
                   RemoteException

Sets the visibility
License requirements: None.

Created in NX5.0.0

Parameters:

type - TRUE if visible, FALSE if invisible

Throws:

NXException

RemoteException

visibility

boolean visibility()
            throws NXException,
                   RemoteException

Returns the visibility
License requirements: None.

Created in NX5.0.0

Throws:

NXException

RemoteException

setDefaultAction

void setDefaultAction()
               throws NXException,
                      RemoteException

Sets default action
License requirements: None.

Created in NX5.0.0

Throws:

NXException

RemoteException