public interface SelectionBox extends StylerItem
Modifier and Type | Interface and Description |
---|---|
static interface |
SelectionBox.Activate
Called when a dialog user selects a list entry with a single mouse click, presses the spacebar on a selected list entry, or presses Return when the cursor is in the text field.
|
static interface |
SelectionBox.DoubleClick
Called when a dialog user double-clicks on an option in the selection box or presses Return when an item is already selected.
|
StylerItem.ItemType
Modifier and Type | Method and Description |
---|---|
void |
addActivateHandler(SelectionBox.Activate activateevent,
boolean isDialogLaunchingEvent)
Registers activate callback.
|
void |
addDoubleClickHandler(SelectionBox.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 |
deselectSubItem(int subItemIndex)
Requests a list entry to be deselected.
|
String[] |
getListItems()
Gets an array of character strings for item names that are used as selectable choices for this dialog item.
|
int |
getSelectedIndexValue()
Gets selected index value
License requirements: None. |
String |
getSelectedString()
Gets selected string
License requirements: None. |
void |
insertSubItem(int subitemIndex,
String[] multiEntries)
Requests that one or more entries be inserted into the list.
|
boolean |
sensitivity()
Returns the sensitivity of the selection box
License requirements: None. |
void |
setFocus()
Indicates that this dialog item is receiving keyboard focus.
|
void |
setLabel(String strLabel)
Specifies the descriptive text string to display below the scrolled list and above the text field.
|
void |
setListItems(String[] values)
Specifies an array of character strings for item names that are used as selectable choices for this dialog item.
|
void |
setSensitivity(boolean type)
Sets the sensitivity of the selection box
License requirements: None. |
void |
setValue(int value)
Sets the value
License requirements: None. |
void |
setVisibility(boolean type)
Sets the visibility of the selection box
License requirements: None. |
void |
showSubItem(int subItemIndex)
Requests that a list entry be scrolled up to the first line in the list.
|
boolean |
visibility()
Returns the visibility of the selection box
License requirements: None. |
getItemType, initializeAttachment, isEqualTo, setAttachment
_value, dispose, printTestData, printTestData
void addActivateHandler(SelectionBox.Activate activateevent, boolean isDialogLaunchingEvent) throws NXException, RemoteException
UIStyler.Dialog#show
or UIStyler.Dialog#registerWithUiMenu
activateevent
- Activate eventisDialogLaunchingEvent
- TRUE if launch new dialog, FALSE if notNXException
RemoteException
void addDoubleClickHandler(SelectionBox.DoubleClick doubleclickevent, boolean isDialogLaunchingEvent) throws NXException, RemoteException
UIStyler.Dialog#show
or UIStyler.Dialog#registerWithUiMenu
doubleclickevent
- Double click eventisDialogLaunchingEvent
- TRUE if launch new dialog, FALSE if notNXException
RemoteException
void setListItems(String[] values) throws NXException, RemoteException
values
- List of items NXException
RemoteException
String[] getListItems() throws NXException, RemoteException
NXException
RemoteException
void setLabel(String strLabel) throws NXException, RemoteException
strLabel
- Label string NXException
RemoteException
void setSensitivity(boolean type) throws NXException, RemoteException
type
- NXException
RemoteException
boolean sensitivity() throws NXException, RemoteException
NXException
RemoteException
void setVisibility(boolean type) throws NXException, RemoteException
type
- NXException
RemoteException
boolean visibility() throws NXException, RemoteException
NXException
RemoteException
void setFocus() throws NXException, RemoteException
NXException
RemoteException
void deselectSubItem(int subItemIndex) throws NXException, RemoteException
subItemIndex
- NXException
RemoteException
void insertSubItem(int subitemIndex, String[] multiEntries) throws NXException, RemoteException
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
- NXException
RemoteException
void append(String[] multiEntries) throws NXException, RemoteException
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. NXException
RemoteException
void deleteSubItem(int subItemIndex) throws NXException, RemoteException
subItemIndex
- NXException
RemoteException
void showSubItem(int subItemIndex) throws NXException, RemoteException
subItemIndex
- NXException
RemoteException
void setValue(int value) throws NXException, RemoteException
value
- NXException
RemoteException
int getSelectedIndexValue() throws NXException, RemoteException
NXException
RemoteException
String getSelectedString() throws NXException, RemoteException
NXException
RemoteException
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.