nxopen.uistyler

Interface MultiSelectList

All Superinterfaces:

Remote, StylerItem, TransientObject

public interface MultiSelectList
extends StylerItem

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	MultiSelectList.Activate
static interface	MultiSelectList.DoubleClick Called when a dialog user selects an entry with a single mouse click or presses the spacebar on a selected item.

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

StylerItem.ItemType

Method Summary

Modifier and Type	Method and Description
void	addActivateHandler(MultiSelectList.Activate activateevent, boolean isDialogLaunchingEvent) Called when a dialog user selects an entry with a double mouse click or presses Return on a selected item.
void	addDoubleClickHandler(MultiSelectList.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) Deletes sub item License requirements: None.
void	deselect(int subItemIndex) Requests a list entry to be deselected.
void	focus() Indicates that this dialog item is receiving keyboard focus.
int[]	getAllIndicesSelected() Gets the indices of all selected list entries.
String[]	getAllNameSelected() Gets the names of all selected list entries.
String[]	getListItems() Gets an array of character strings for item names that are used as selectable choices for this dialog item.
void	insertSubitems(int subitemIndex, String[] multiEntries) License requirements: None.
boolean	sensitivity() Returns the senstivity License requirements: None.
void	setAllSelected() Specifies all list entry to be selected.
void	setListItems(String[] itemVal) Specifies an array of character strings for item names that are used as selectable choices for this dialog item.
void	setSelected(int subIndex) Specifies particular list items to be selected.
void	setSensitivity(boolean type) Sets the senstivity License requirements: None.
void	setVisibility(boolean type) Sets the visibility License requirements: None.
void	showSubItem(int subItemIndex) Requests a list entry to be scrolled up to the first line in the list 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(MultiSelectList.Activate activateevent,
                        boolean isDialogLaunchingEvent)
                 throws NXException,
                        RemoteException

Called when a dialog user selects an entry with a double mouse click or presses Return on a selected item.
License requirements: None.

Created in NX5.0.0

Parameters:

activateevent -

isDialogLaunchingEvent -

Throws:

NXException

RemoteException

addDoubleClickHandler

void addDoubleClickHandler(MultiSelectList.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

setListItems

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

Specifies an array of character strings for item names that are used as selectable choices for this dialog item.
License requirements: None.

Created in NX5.0.0

Parameters:

itemVal - array of character strings for item names

Throws:

NXException

RemoteException

getListItems

String[] getListItems()
               throws NXException,
                      RemoteException

Gets an array of character strings for item names that are used as selectable choices for this dialog item.
License requirements: None.

Created in NX5.0.0

Returns:

An array of character strings for item names

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 - An index of particular list items to be selected

Throws:

NXException

RemoteException

setAllSelected

void setAllSelected()
             throws NXException,
                    RemoteException

Specifies all list entry to be selected.
License requirements: None.

Created in NX5.0.0

Throws:

NXException

RemoteException

getAllIndicesSelected

int[] getAllIndicesSelected()
                     throws NXException,
                            RemoteException

Gets the indices of all selected list entries.
License requirements: None.

Created in NX5.0.0

Returns:

An array of integers for item indices of selected items

Throws:

NXException

RemoteException

getAllNameSelected

String[] getAllNameSelected()
                     throws NXException,
                            RemoteException

Gets the names of all selected list entries.
License requirements: None.

Created in NX5.0.0

Returns:

An array of character strings of selected items

Throws:

NXException

RemoteException

setSensitivity

void setSensitivity(boolean type)
             throws NXException,
                    RemoteException

Sets the senstivity
License requirements: None.

Created in NX5.0.0

Parameters:

type -

Throws:

NXException

RemoteException

sensitivity

boolean sensitivity()
             throws NXException,
                    RemoteException

Returns the senstivity
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 -

Throws:

NXException

RemoteException

visibility

boolean visibility()
            throws NXException,
                   RemoteException

Returns the visibility
License requirements: None.

Created in NX5.0.0

Throws:

NXException

RemoteException

focus

void focus()
    throws NXException,
           RemoteException

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

Created in NX5.0.0

Throws:

NXException

RemoteException

deselect

void deselect(int subItemIndex)
       throws NXException,
              RemoteException

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

Created in NX5.0.0

Parameters:

subItemIndex - Index of the list entry to be deselected.

Throws:

NXException

RemoteException

insertSubitems

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

License requirements: None.

Created in NX5.0.0

Parameters:

subitemIndex - Sub item index

multiEntries - An array of items to be inserted

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.

Throws:

NXException

RemoteException

deleteSubitem

void deleteSubitem(int subItemIndex)
            throws NXException,
                   RemoteException

Deletes sub item
License requirements: None.

Created in NX5.0.0

Parameters:

subItemIndex - Zero-based index of a list entry to be deleted

Throws:

NXException

RemoteException

showSubItem

void showSubItem(int subItemIndex)
          throws NXException,
                 RemoteException

Requests a list entry to 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