public interface SetList extends UIBlock
Modifier and Type | Interface and Description |
---|---|
static interface |
SetList.AddCallback
Add callback
|
static interface |
SetList.DeleteCallback
Delete callback.
|
static class |
SetList.InsertionLocation
During Insert, indicates whether component should be
inserted before or after the insertion location
|
static interface |
SetList.ReorderCallback
Reorder callback
|
Modifier and Type | Method and Description |
---|---|
UIBlock |
addNewSet(boolean copyPropertiesAndSelect)
Adds an item to the end of the list
License requirements: None. |
String |
addNewSetLabel()
Returns the AddNewSetLabel.
|
int |
defaultColumnWidth()
Returns the DefaultColumnWidth
License requirements: None. |
void |
delete(UIBlock uicomp)
Deletes an item from the list
License requirements: None. |
UIBlock |
findUpdated()
When an update event occurs on the list, this method finds the
item in the list that was updated
License requirements: None. |
String[] |
getColumnLabels()
Gets the ColumnLabels
License requirements: None. |
int[] |
getColumnWidths()
Gets the ColumnWidths
License requirements: None. |
UIBlock[] |
getItems()
Gets all the items in the list
License requirements: None. |
String[] |
getItemText(UIBlock item)
Gets the text for the specified item.
|
String[] |
getLayoutMembers()
Gets the Layout members
License requirements: None. |
UIBlock[] |
getSelected()
Gets the selected items
License requirements: None. |
UIBlock |
insertNewSet(UIBlock location,
SetList.InsertionLocation insertBeforeOrAfter,
boolean copyPropertiesAndSelect)
Inserts an item before or after a specified item
License requirements: None. |
boolean |
isAddButtonSensitive()
Returns the IsAddButtonSensitive
License requirements: None. |
String |
layoutAsString()
Returns the Layout as string
License requirements: None. |
boolean |
listExpanded()
Returns the ListExpanded.
|
boolean |
listHideGroup()
Returns the ListHideGroup
License requirements: None. |
int |
maximumHeight()
Returns the MaximumHeight
License requirements: None. |
int |
minimumHeight()
Returns the MinimumHeight
License requirements: None. |
boolean |
multipleEdit()
Returns the MultipleEdit
License requirements: None. |
String |
numberColumnString()
Returns the NumberColumnString as string
License requirements: None. |
int |
numberOfColumns()
Returns the NumberOfColumns
License requirements: None. |
boolean |
resizeHeightWithDialog()
Returns the ResizeHeightWithDialog.
|
String |
seedDlxFile()
Returns the SeedDlxFile as string
License requirements: None. |
void |
setAddButtonSensitive(boolean addButton)
License requirements: None. |
void |
setAddHandler(SetList.AddCallback cb)
Sets the AddNewSet handler.
|
void |
setAddNewSetLabel(String label)
License requirements: None. |
void |
setColumnLabels(String[] labels)
Sets the ColumnLabels
License requirements: None. |
void |
setColumnWidths(int[] width)
Sets the ColumnWidths
License requirements: None. |
void |
setDefaultColumnWidth(int defaultWidth)
License requirements: None. |
void |
setDeleteHandler(SetList.DeleteCallback cb)
Sets the Delete handler.
|
void |
setItemText(UIBlock item,
String[] strings)
Sets the text for the specified item.
|
void |
setLayoutAsString(String enumString)
License requirements: None. |
void |
setListExpanded(boolean expanded)
License requirements: None. |
void |
setListHideGroup(boolean listHideGroup)
License requirements: None. |
void |
setMaximumHeight(int maxHeight)
License requirements: None. |
void |
setMinimumHeight(int minHeight)
License requirements: None. |
void |
setMultipleEdit(boolean multipleEdit)
License requirements: None. |
void |
setNumberColumnString(String columnString)
License requirements: None. |
void |
setNumberOfColumns(int numColumns)
License requirements: None. |
void |
setReorderObserver(SetList.ReorderCallback cb)
Sets the Reorder observer.
|
void |
setResizeHeightWithDialog(boolean resize)
License requirements: None. |
void |
setSeed(String dlxFile)
Sets the seed using a dlx file.
|
void |
setSeedDlxFile(String dlxName)
License requirements: None. |
void |
setSelected(UIBlock[] items)
Sets the selected items.
|
void |
setShowAddNewSet(boolean show)
License requirements: None. |
void |
setShowColumnHeadings(boolean show)
License requirements: None. |
void |
setShowRemove(boolean show)
License requirements: None. |
void |
setShowReorderControls(boolean show)
License requirements: None. |
boolean |
showAddNewSet()
Returns the ShowAddNewSet.
|
boolean |
showColumnHeadings()
Returns the ShowColumnHeadings
License requirements: None. |
boolean |
showRemove()
Returns the ShowRemove.
|
boolean |
showReorderControls()
Returns the ShowReorderControls
License requirements: None. |
void |
swap(UIBlock uicomp1,
UIBlock uicomp2)
Swaps the location of two items
License requirements: None. |
enable, expanded, focus, getProperties, group, label, name, setEnable, setExpanded, setGroup, setLabel, setShow, show, type
printTestData, printTestData, tag, tagValue
void setSeed(String dlxFile) throws NXException, RemoteException
dlxFile
- The dlx file used to create the seed NXException
RemoteException
void setAddHandler(SetList.AddCallback cb) throws NXException, RemoteException
cb
- NXException
RemoteException
void setDeleteHandler(SetList.DeleteCallback cb) throws NXException, RemoteException
cb
- NXException
RemoteException
void setReorderObserver(SetList.ReorderCallback cb) throws NXException, RemoteException
cb
- NXException
RemoteException
UIBlock addNewSet(boolean copyPropertiesAndSelect) throws NXException, RemoteException
copyPropertiesAndSelect
- Indicates whether to copy properties from the
currently selected component and set focus to the new setNXException
RemoteException
void delete(UIBlock uicomp) throws NXException, RemoteException
uicomp
- Item to deleteNXException
RemoteException
void swap(UIBlock uicomp1, UIBlock uicomp2) throws NXException, RemoteException
uicomp1
- Item to swapuicomp2
- Item to swapNXException
RemoteException
UIBlock insertNewSet(UIBlock location, SetList.InsertionLocation insertBeforeOrAfter, boolean copyPropertiesAndSelect) throws NXException, RemoteException
location
- Location to insert the new iteminsertBeforeOrAfter
- Indicates whether to insert the new item before or after the specified locationcopyPropertiesAndSelect
- Indicates whether to copy properties from the
currently selected component and set focus to the new setNXException
RemoteException
void setItemText(UIBlock item, String[] strings) throws NXException, RemoteException
item
- strings
- The text. The text may only contain characters in the locale character setNXException
RemoteException
String[] getItemText(UIBlock item) throws NXException, RemoteException
item
- NXException
RemoteException
UIBlock findUpdated() throws NXException, RemoteException
NXException
RemoteException
UIBlock[] getSelected() throws NXException, RemoteException
NXException
RemoteException
void setSelected(UIBlock[] items) throws NXException, RemoteException
items
- NXException
RemoteException
UIBlock[] getItems() throws NXException, RemoteException
NXException
RemoteException
String addNewSetLabel() throws NXException, RemoteException
NXException
RemoteException
void setAddNewSetLabel(String label) throws NXException, RemoteException
label
- NXException
RemoteException
String[] getColumnLabels() throws NXException, RemoteException
NXException
RemoteException
void setColumnLabels(String[] labels) throws NXException, RemoteException
labels
- Values to set to the propertyNXException
RemoteException
int[] getColumnWidths() throws NXException, RemoteException
NXException
RemoteException
void setColumnWidths(int[] width) throws NXException, RemoteException
width
- Values to set to the propertyNXException
RemoteException
int defaultColumnWidth() throws NXException, RemoteException
NXException
RemoteException
void setDefaultColumnWidth(int defaultWidth) throws NXException, RemoteException
defaultWidth
- NXException
RemoteException
boolean isAddButtonSensitive() throws NXException, RemoteException
NXException
RemoteException
void setAddButtonSensitive(boolean addButton) throws NXException, RemoteException
addButton
- NXException
RemoteException
String layoutAsString() throws NXException, RemoteException
NXException
RemoteException
void setLayoutAsString(String enumString) throws NXException, RemoteException
enumString
- NXException
RemoteException
String[] getLayoutMembers() throws NXException, RemoteException
NXException
RemoteException
boolean listExpanded() throws NXException, RemoteException
NXException
RemoteException
void setListExpanded(boolean expanded) throws NXException, RemoteException
expanded
- NXException
RemoteException
boolean listHideGroup() throws NXException, RemoteException
NXException
RemoteException
void setListHideGroup(boolean listHideGroup) throws NXException, RemoteException
listHideGroup
- NXException
RemoteException
int maximumHeight() throws NXException, RemoteException
NXException
RemoteException
void setMaximumHeight(int maxHeight) throws NXException, RemoteException
maxHeight
- NXException
RemoteException
int minimumHeight() throws NXException, RemoteException
NXException
RemoteException
void setMinimumHeight(int minHeight) throws NXException, RemoteException
minHeight
- NXException
RemoteException
boolean multipleEdit() throws NXException, RemoteException
NXException
RemoteException
void setMultipleEdit(boolean multipleEdit) throws NXException, RemoteException
multipleEdit
- NXException
RemoteException
String numberColumnString() throws NXException, RemoteException
NXException
RemoteException
void setNumberColumnString(String columnString) throws NXException, RemoteException
columnString
- NXException
RemoteException
int numberOfColumns() throws NXException, RemoteException
NXException
RemoteException
void setNumberOfColumns(int numColumns) throws NXException, RemoteException
numColumns
- NXException
RemoteException
boolean resizeHeightWithDialog() throws NXException, RemoteException
NXException
RemoteException
void setResizeHeightWithDialog(boolean resize) throws NXException, RemoteException
resize
- NXException
RemoteException
String seedDlxFile() throws NXException, RemoteException
NXException
RemoteException
void setSeedDlxFile(String dlxName) throws NXException, RemoteException
dlxName
- NXException
RemoteException
boolean showAddNewSet() throws NXException, RemoteException
NXException
RemoteException
void setShowAddNewSet(boolean show) throws NXException, RemoteException
show
- NXException
RemoteException
boolean showColumnHeadings() throws NXException, RemoteException
NXException
RemoteException
void setShowColumnHeadings(boolean show) throws NXException, RemoteException
show
- NXException
RemoteException
boolean showRemove() throws NXException, RemoteException
NXException
RemoteException
void setShowRemove(boolean show) throws NXException, RemoteException
show
- NXException
RemoteException
boolean showReorderControls() throws NXException, RemoteException
NXException
RemoteException
void setShowReorderControls(boolean show) throws NXException, RemoteException
show
- NXException
RemoteException
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.