nxopen.uistyler

Interface SingleSelectList

All Superinterfaces:

Remote, StylerItem, TransientObject

public interface SingleSelectList
extends StylerItem

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	SingleSelectList.Activate Called when a dialog user selects an entry with a single mouse click or presses the spacebar on an already selected item.
static interface	SingleSelectList.DoubleClick Called when a dialog user double-clicks on an option or presses Return when an item is already selected.

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

StylerItem.ItemType

Method Summary

Modifier and Type	Method and Description
void	addActivateHandler(SingleSelectList.Activate activateevent, boolean isDialogLaunchingEvent) Registers activate callback.
void	addDoubleClickHandler(SingleSelectList.DoubleClick doubleclickevent, boolean isDialogLaunchingEvent) Registers double click callback.
void	append(String[] multiEntries) Appends one or more entries to be inserted into the list License requirements: None.
void	deleteSubItem(int subItemIndex) Requests a list entry to be deleted.
void	deselectSubItem(int subItemIndex) Requests a list entry to be deselected.
String[]	getListItems() Gets an array of character strings that are used as entries in the list.
int	getSelectedIndexValue() Gets selected index License requirements: None.
String	getSelectedString() Gets selected string License requirements: None.
boolean	hasSelected() Returns whether or not an item has been selected License requirements: None.
void	insertSubItem(int subitemIndex, String[] multiEntries) Requests one or more entries to be inserted into the list.
boolean	sensitivity() Returns the sensitivity of the single select list License requirements: None.
void	setFocus() Indicates that this dialog item is receiving keyboard focus.
void	setListItems(String[] itemVal) Specifies an array of character strings that are used as entries in the list License requirements: None.
void	setSelected(int subIndex) Specifies particular list items to be selected License requirements: None.
void	setSensitivity(boolean type) Sets the sensitivity of the single select list License requirements: None.
void	setVisibility(boolean type) Sets the visibility of the single select list License requirements: None.
void	showSubItem(int subItemIndex) Requests that a list entry be scrolled up to the first line in the list License requirements: None.
boolean	visibility() Returns the visibility of the single select list 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(SingleSelectList.Activate activateevent,
                        boolean isDialogLaunchingEvent)
                 throws NXException,
                        RemoteException

Registers activate callback. This method should be called before calling UIStyler.Dialog#show or UIStyler.Dialog#registerWithUiMenu
License requirements: None.

Created in NX5.0.0

Parameters:

activateevent -

isDialogLaunchingEvent -

Throws:

NXException

RemoteException

addDoubleClickHandler

void addDoubleClickHandler(SingleSelectList.DoubleClick doubleclickevent,
                           boolean isDialogLaunchingEvent)
                    throws NXException,
                           RemoteException

Registers double click callback. This method should be called before calling UIStyler.Dialog#show or UIStyler.Dialog#registerWithUiMenu
License requirements: None.

Created in NX5.0.0

Parameters:

doubleclickevent -

isDialogLaunchingEvent -

Throws:

NXException

RemoteException

setSelected

void setSelected(int subIndex)
          throws NXException,
                 RemoteException

Specifies particular list items to be selected
License requirements: None.

Created in NX5.0.0

Parameters:

subIndex - Inndex of particular list items to be selected

Throws:

NXException

RemoteException

setListItems

void setListItems(String[] itemVal)
           throws NXException,
                  RemoteException

Specifies an array of character strings that are used as entries in the list
License requirements: None.

Created in NX5.0.0

Parameters:

itemVal - An array of string items
NOTE: The full Unicode character set is not supported for this parameter.

Throws:

NXException

RemoteException

getListItems

String[] getListItems()
               throws NXException,
                      RemoteException

Gets an array of character strings that are used as entries in the list.
License requirements: None.

Created in NX5.0.0

Returns:

An array of string items

Throws:

NXException

RemoteException

setSensitivity

void setSensitivity(boolean type)
             throws NXException,
                    RemoteException

Sets the sensitivity of the single select list
License requirements: None.

Created in NX5.0.0

Parameters:

type -

Throws:

NXException

RemoteException

sensitivity

boolean sensitivity()
             throws NXException,
                    RemoteException

Returns the sensitivity of the single select list
License requirements: None.

Created in NX5.0.0

Throws:

NXException

RemoteException

setVisibility

void setVisibility(boolean type)
            throws NXException,
                   RemoteException

Sets the visibility of the single select list
License requirements: None.

Created in NX5.0.0

Parameters:

type -

Throws:

NXException

RemoteException

visibility

boolean visibility()
            throws NXException,
                   RemoteException

Returns the visibility of the single select list
License requirements: None.

Created in NX5.0.0

Throws:

NXException

RemoteException

setFocus

void setFocus()
       throws NXException,
              RemoteException

Indicates that this dialog item is receiving keyboard focus.
License requirements: None.

Created in NX5.0.0

Throws:

NXException

RemoteException

deselectSubItem

void deselectSubItem(int subItemIndex)
              throws NXException,
                     RemoteException

Requests a list entry to be deselected.
License requirements: None.

Created in NX5.0.0

Parameters:

subItemIndex -

Throws:

NXException

RemoteException

insertSubItem

void insertSubItem(int subitemIndex,
                   String[] multiEntries)
            throws NXException,
                   RemoteException

Requests one or more entries to be inserted into the list. You can insert entries at the bottom of the list or at any position within the list.
License requirements: None.

Created in NX5.0.0

Parameters:

subitemIndex - Position index where the insertion should be made. If subitem_index equals UF_STYLER_NO_SUB_INDEX, then the new list entries are added to the bottom of the list.

multiEntries - An array of entry names to be inserted into the list. This field is used only when more than one entry are to be inserted into the list.
NOTE: The full Unicode character set is not supported for this parameter.

Throws:

NXException

RemoteException

append

void append(String[] multiEntries)
     throws NXException,
            RemoteException

Appends one or more entries to be inserted into the list
License requirements: None.

Created in NX5.0.0

Parameters:

multiEntries - An array of entry names to be inserted into the list. This field is used only when more than one entry are to be inserted into the list.
NOTE: The full Unicode character set is not supported for this parameter.

Throws:

NXException

RemoteException

deleteSubItem

void deleteSubItem(int subItemIndex)
            throws NXException,
                   RemoteException

Requests a list entry to be deleted.
License requirements: None.

Created in NX5.0.0

Parameters:

subItemIndex - Zero-based index of a list entry to be deleted. If subitem_index equals UF_STYLER_NO_SUB_INDEX, then all list entries are deleted.

Throws:

NXException

RemoteException

showSubItem

void showSubItem(int subItemIndex)
          throws NXException,
                 RemoteException

Requests that a list entry be scrolled up to the first line in the list
License requirements: None.

Created in NX5.0.0

Parameters:

subItemIndex - Zero-based index of a list entry to be scrolled up to the first line of the list.

Throws:

NXException

RemoteException

getSelectedIndexValue

int getSelectedIndexValue()
                   throws NXException,
                          RemoteException

Gets selected index
License requirements: None.

Created in NX5.0.0

Throws:

NXException

RemoteException

getSelectedString

String getSelectedString()
                  throws NXException,
                         RemoteException

Gets selected string
License requirements: None.

Created in NX5.0.0

Throws:

NXException

RemoteException

hasSelected

boolean hasSelected()
             throws NXException,
                    RemoteException

Returns whether or not an item has been selected
License requirements: None.

Created in NX7.5.1

Throws:

NXException

RemoteException