|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.tivoli.twg.alertmgr.TWGActionParm
com.tivoli.twg.alertmgr.TWGActionParmListBox
An abstract class for designating that an Event Action parameter should take the form of a list of choices.
Field Summary | |
---|---|
protected java.lang.String |
itemsBundle
|
Fields inherited from class com.tivoli.twg.alertmgr.TWGActionParm |
---|
ACTION_PARM_DROPDOWN, ACTION_PARM_FLOAT_SPINNER, ACTION_PARM_KEYED_DROPDOWN, ACTION_PARM_KEYED_MULTI_SEL_LIST, ACTION_PARM_LONG_SPINNER, ACTION_PARM_MULTI_SEL_LIST, ACTION_PARM_STRING_SPINNER, ACTION_PARM_STRING_TREE, ACTION_PARM_TEXTAREA, ACTION_PARM_TEXTBOX |
Constructor Summary | |
---|---|
TWGActionParmListBox(IntelByteBuffer buf,
int type)
Constructor for interpreting a provided IntelByteBuffer. |
|
TWGActionParmListBox(IntelByteBuffer buf,
int off,
int type)
Constructor for interpreting a provided IntelByteBuffer at a given offset. |
|
TWGActionParmListBox(int index,
int type,
java.lang.String label,
java.lang.String labelBundle,
java.lang.String sublabel,
java.lang.String sublabelBundle,
java.lang.String[] choices,
java.lang.String choicesBundle)
Constructor for a single or multi-select list of strings action parameter where no pre-selections are made. |
|
TWGActionParmListBox(int index,
int type,
java.lang.String label,
java.lang.String labelBundle,
java.lang.String sublabel,
java.lang.String sublabelBundle,
java.lang.String[] choices,
java.lang.String choicesBundle,
int defaultChoice)
Constructor for a single-select list of strings action parameter. |
|
TWGActionParmListBox(int index,
int type,
java.lang.String label,
java.lang.String labelBundle,
java.lang.String sublabel,
java.lang.String sublabelBundle,
java.lang.String[] choices,
java.lang.String choicesBundle,
int[] defaultChoices)
Constructor for a multi-select list of strings action parameter. |
|
TWGActionParmListBox(TWGActionParmListBox aplb)
Copy constructor. |
Method Summary | |
---|---|
abstract java.awt.Component |
getGuiComponent()
Get the graphical component associated with this TWGActionParm subclass. |
java.lang.String |
getItem(int index)
Get the value of the selectable item referenced by the given index. |
java.lang.String |
getItemsBundle()
Get the bundle associated with the list of selectable items. |
java.lang.String[] |
getListOfItems()
Get a reference to the list of selectable items. |
java.lang.String[] |
getListOfItems(java.util.Locale locale)
Get the list of selectable items based on the given locale. |
int |
getNumSelectedItems()
Get the number of currently selected items. |
int |
getSelected()
Get the index of the currently selected item. |
int[] |
getSelectedItems()
Get a list of indices that reference selected items. |
void |
print()
Print the contents of the TWGActionParmListBox. |
int |
readTWGActionParmListBox(IntelByteBuffer buf,
int off,
int type)
Method for interpreting a provided IntelByteBuffer at a given offset. |
abstract void |
saveValues(java.awt.Component comp)
Save the user customized value(s) of this action parameter. |
void |
setItem(int index,
java.lang.String s)
Set the value of the selectable item referenced by the given index. |
void |
setItemsBundle(java.lang.String bundle)
Set the bundle associated with the list of selectable items. |
void |
setListOfItems(java.lang.String[] list)
Set a the list of selectable items. |
void |
setSelected(int itemIndex)
Set the currently selected item to the item referenced by a given index. |
void |
setSelectedItems(int[] intArray)
Set the currently selected items to the items referenced by a given array of indices. |
int |
sizeOf()
Determine the size of the entire TWGActionParmListBox object |
static int |
sizeOfHdr()
Determine the size of the header information. |
int |
sizeOfTWGActionParmListBox()
Determine the size of the entire TWGActionParmListBox object |
IntelByteBuffer |
toIntelByteBuffer()
Convert the TWGActionParmListBox into IntelByteBuffer representation. |
abstract boolean |
wasModified(java.awt.Component comp)
Determine if the user modified the value(s) of this action parameter. |
int |
writeIntelByteBuffer(IntelByteBuffer buf)
Write contents of this object into an IntelByteBuffer. |
int |
writeIntelByteBuffer(IntelByteBuffer buf,
int off)
Write action parm into provided IntelByteBuffer starting at a given offset. |
Methods inherited from class com.tivoli.twg.alertmgr.TWGActionParm |
---|
getCapturedValues, getCapturedValues, getIndex, getLabel, getLabel, getLabelBundle, getSubLabel, getSubLabel, getSubLabelBundle, readTWGActionParm, setIndex, setLabel, setLabel, setLabelBundle, setSubLabel, setSubLabel, setSubLabelBundle, setType, sizeOfTWGActionParm, traceString, traceValue, unwrap, unwrap |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected java.lang.String itemsBundle
Constructor Detail |
public TWGActionParmListBox(int index, int type, java.lang.String label, java.lang.String labelBundle, java.lang.String sublabel, java.lang.String sublabelBundle, java.lang.String[] choices, java.lang.String choicesBundle, int[] defaultChoices)
index
- Index of action parameter (used as a reference key)type
- Integer encoding of subclass typelabel
- Label (or associated bundle keyword if label bundle non-null).choices
- Array of choices presented to the user.
Literal strings or associated bundle keywords if choices bundle non-null. array of choices presented to the userchoicesBundle
- Bundle containing choices referenced choices keywordsdefaultChoices
- Array of indices that reference the array of choices indicating
pre-selected values.public TWGActionParmListBox(int index, int type, java.lang.String label, java.lang.String labelBundle, java.lang.String sublabel, java.lang.String sublabelBundle, java.lang.String[] choices, java.lang.String choicesBundle, int defaultChoice)
index
- Index of action parameter (used as a reference key)type
- Integer encoding of subclass typelabel
- Label (or associated bundle keyword if label bundle non-null).choices
- Array of choices presented to the user.
Literal strings or associated bundle keywords if choices bundle non-null. array of choices presented to the userchoicesBundle
- Bundle containing choices referenced choices keywordsdefaultChoice
- Index of the default selection in the array of choicespublic TWGActionParmListBox(int index, int type, java.lang.String label, java.lang.String labelBundle, java.lang.String sublabel, java.lang.String sublabelBundle, java.lang.String[] choices, java.lang.String choicesBundle)
index
- Index of action parameter (used as a reference key)type
- Integer encoding of subclass typelabel
- Label (or associated bundle keyword if label bundle non-null).choices
- Array of choices presented to the user.
Literal strings or associated bundle keywords if choices bundle non-null. array of choices presented to the userchoicesBundle
- Bundle containing choices referenced choices keywordspublic TWGActionParmListBox(TWGActionParmListBox aplb)
public TWGActionParmListBox(IntelByteBuffer buf, int type)
buf
- IntelByteBuffer from which data should be readtype
- Integer encoding of the TWGActionParm subclasspublic TWGActionParmListBox(IntelByteBuffer buf, int off, int type)
buf
- IntelByteBuffer from which data should be readoff
- offset from the current relative start of the provided IntelByteBuffertype
- Integer encoding of the TWGActionParm subclassMethod Detail |
public static int sizeOfHdr()
public int sizeOfTWGActionParmListBox()
public int sizeOf()
sizeOf
in class TWGActionParm
public IntelByteBuffer toIntelByteBuffer()
toIntelByteBuffer
in class TWGActionParm
public int writeIntelByteBuffer(IntelByteBuffer buf)
writeIntelByteBuffer
in class TWGActionParm
buf
- IntelByteBuffer into which data should be written
public int writeIntelByteBuffer(IntelByteBuffer buf, int off)
writeIntelByteBuffer
in class TWGActionParm
buf
- IntelByteBuffer into which data should be writtenoff
- offset from the current relative start of the provided IntelByteBuffer
public int readTWGActionParmListBox(IntelByteBuffer buf, int off, int type)
buf
- IntelByteBuffer from which TWGActionParm should be readoff
- offset from the current relative start of the provided IntelByteBuffertype
- Integer encoding of the TWGActionParm subclass
public abstract java.awt.Component getGuiComponent()
getGuiComponent
in class TWGActionParm
public abstract void saveValues(java.awt.Component comp)
saveValues
in class TWGActionParm
comp
- instance of the Swing component this subclass uses to display the action parameterpublic abstract boolean wasModified(java.awt.Component comp)
wasModified
in class TWGActionParm
comp
- instance of the Swing component this subclass uses to display the action parameterpublic java.lang.String getItem(int index)
index
- Index of the selectable item.
public java.lang.String[] getListOfItems(java.util.Locale locale)
locale
- Locale of the desired language.
public void setItem(int index, java.lang.String s)
index
- Index of the selectable item.s
- New value.
public java.lang.String[] getListOfItems()
public void setListOfItems(java.lang.String[] list)
list
- New list of selectable items.public java.lang.String getItemsBundle()
public void setItemsBundle(java.lang.String bundle)
bundle
- New bundle name.public int getSelected()
public int getNumSelectedItems()
public int[] getSelectedItems()
public void setSelected(int itemIndex)
itemIndex
- Index of the selected item.public void setSelectedItems(int[] intArray)
intArray
- Array of indices.public void print()
print
in class TWGActionParm
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |