|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.tivoli.twg.alertmgr.TWGActionParm
An abstract base class for describing the characteristers of an action parameter in an Event Action. Those features that are common to all action parms are housed here.
Field Summary | |
---|---|
protected static int |
ACTION_PARM_DROPDOWN
|
protected static int |
ACTION_PARM_FLOAT_SPINNER
|
protected static int |
ACTION_PARM_KEYED_DROPDOWN
|
protected static int |
ACTION_PARM_KEYED_MULTI_SEL_LIST
|
protected static int |
ACTION_PARM_LONG_SPINNER
|
protected static int |
ACTION_PARM_MULTI_SEL_LIST
|
protected static int |
ACTION_PARM_STRING_SPINNER
|
protected static int |
ACTION_PARM_STRING_TREE
|
protected static int |
ACTION_PARM_TEXTAREA
|
protected static int |
ACTION_PARM_TEXTBOX
|
Constructor Summary | |
---|---|
protected |
TWGActionParm(IntelByteBuffer buf)
Constructor for interpreting a provided IntelByteBuffer. |
protected |
TWGActionParm(IntelByteBuffer buf,
int off)
Constructor for interpreting a provided IntelByteBuffer at a given offset. |
|
TWGActionParm(int idx,
int type,
java.lang.String label,
java.lang.String labBundle,
java.lang.String subLabel,
java.lang.String subLabBundle)
Constructor for the NLS-enabled action parameter. |
|
TWGActionParm(TWGActionParm ap)
Copy constructor. |
Method Summary | |
---|---|
java.lang.String |
getCapturedValues()
returns the values stored for the given actionparm. |
java.lang.String |
getCapturedValues(java.util.Locale locale)
|
abstract java.awt.Component |
getGuiComponent()
Get the graphical component associated with this TWGActionParm subclass. |
int |
getIndex()
Get the index of action parameter. |
java.lang.String |
getLabel()
Get the action parameter's label. |
java.lang.String |
getLabel(java.util.Locale locale)
Get the label of the action parameter based on a desired locale. |
java.lang.String |
getLabelBundle()
Get the bundle associated with the action parameter's label keyword. |
java.lang.String |
getSubLabel()
Get the action parameter's sub-label. |
java.lang.String |
getSubLabel(java.util.Locale locale)
Get the sub-label of the action parameter based on a desired locale. |
java.lang.String |
getSubLabelBundle()
Get the bundle associated with the action parameter's sub-label keyword. |
void |
print()
Print label and sub-label of this action parameter. |
int |
readTWGActionParm(IntelByteBuffer buf,
int off)
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 |
setIndex(int idx)
Set the index of action parameter. |
void |
setLabel(java.lang.String lbl)
Set the action parameter's label. |
void |
setLabel(java.lang.String lbl,
java.lang.String bdl)
Set the action parameter's label using a keyword and bundle. |
void |
setLabelBundle(java.lang.String lb)
Set the bundle containing the keyword associated with the action parameter's label. |
void |
setSubLabel(java.lang.String lbl)
Set the action parameter's sub-label. |
void |
setSubLabel(java.lang.String lbl,
java.lang.String bdl)
Set the action parameter's sub-label using a keyword and bundle. |
void |
setSubLabelBundle(java.lang.String slb)
Set the bundle containing the keyword associated with the action parameter's sub-label. |
protected void |
setType(int t)
Set the encoded TWGActionParm subclass type. |
int |
sizeOf()
Determine the size of the entire TWGActionParm object |
static int |
sizeOfHdr()
Determine the size of the TWGActionParm header information. |
int |
sizeOfTWGActionParm()
Determine the size of the entire TWGActionParm object |
abstract IntelByteBuffer |
toIntelByteBuffer()
Convert the TWGActionParm into IntelByteBuffer representation. |
java.lang.String |
traceString()
|
java.lang.String |
traceValue()
|
static TWGActionParm |
unwrap(IntelByteBuffer buf)
Convert the IntelByteBuffer into the appropriate TWGActionParm object. |
static TWGActionParm |
unwrap(IntelByteBuffer buf,
int off)
Convert the IntelByteBuffer (starting at the given offset) into the appropriate TWGActionParm object. |
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 java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected static final int ACTION_PARM_TEXTBOX
protected static final int ACTION_PARM_STRING_SPINNER
protected static final int ACTION_PARM_DROPDOWN
protected static final int ACTION_PARM_LONG_SPINNER
protected static final int ACTION_PARM_FLOAT_SPINNER
protected static final int ACTION_PARM_MULTI_SEL_LIST
protected static final int ACTION_PARM_STRING_TREE
protected static final int ACTION_PARM_TEXTAREA
protected static final int ACTION_PARM_KEYED_DROPDOWN
protected static final int ACTION_PARM_KEYED_MULTI_SEL_LIST
Constructor Detail |
public TWGActionParm(int idx, int type, java.lang.String label, java.lang.String labBundle, java.lang.String subLabel, java.lang.String subLabBundle)
idx
- index of action parameter (used as a reference)type
- integer encoding of subclass typelabel
- label (or associated bundle keyword if label bundle non-null).labBundle
- bundle containing label referenced label keywordsubLabel
- sublabel (or associated bundle keyword if sublabel bundle non-null).subLabBundle
- bundle containing sublabel referenced subLabel keywordpublic TWGActionParm(TWGActionParm ap)
protected TWGActionParm(IntelByteBuffer buf)
buf
- IntelByteBuffer from which TWGActionParm should be readprotected TWGActionParm(IntelByteBuffer buf, int off)
buf
- IntelByteBuffer from which TWGActionParm should be readoff
- offset from the current relative start of the provided IntelByteBufferMethod Detail |
public static int sizeOfHdr()
public int sizeOfTWGActionParm()
public int sizeOf()
public abstract IntelByteBuffer toIntelByteBuffer()
public static TWGActionParm unwrap(IntelByteBuffer buf)
buf
- IntelByteBuffer to be converted
public static TWGActionParm unwrap(IntelByteBuffer buf, int off)
buf
- IntelByteBuffer to be convertedoff
- offset into the provided IntelByteBuffer
public int writeIntelByteBuffer(IntelByteBuffer buf)
buf
- IntelByteBuffer into which data should be written
public int writeIntelByteBuffer(IntelByteBuffer buf, int off)
buf
- IntelByteBuffer into which data should be writtenoff
- offset from the current relative start of the provided IntelByteBuffer
public int readTWGActionParm(IntelByteBuffer buf, int off)
buf
- IntelByteBuffer from which TWGActionParm should be readoff
- offset from the current relative start of the provided IntelByteBuffer
public java.lang.String getLabel()
public void setLabel(java.lang.String lbl)
lbl
- label or keyword associated with label of the action parameterpublic void setLabel(java.lang.String lbl, java.lang.String bdl)
lbl
- keyword associated with label of the action parameterbdl
- bundle containing keyword associated with label of the action parameterpublic java.lang.String getLabelBundle()
public void setLabelBundle(java.lang.String lb)
lb
- bundle containing keyword associated with label of the action parameterpublic java.lang.String getSubLabel()
public void setSubLabel(java.lang.String lbl)
lbl
- sub-label or keyword associated with the sub-label of the action parameterpublic void setSubLabel(java.lang.String lbl, java.lang.String bdl)
lbl
- keyword associated with sub-label of the action parameterbdl
- bundle containing keyword associated with the sub-label of the action parameterpublic java.lang.String getSubLabelBundle()
public void setSubLabelBundle(java.lang.String slb)
slb
- bundle containing keyword associated with the sub-label of the action parameterprotected void setType(int t)
t
- integer representing the type of TWGActionParm subclass being encodedpublic int getIndex()
public void setIndex(int idx)
idx
- index identifier of action parameterpublic java.lang.String getLabel(java.util.Locale locale)
locale
- locale of the label being requested
public java.lang.String getSubLabel(java.util.Locale locale)
locale
- locale of the label being requested
public abstract java.awt.Component getGuiComponent()
public abstract void saveValues(java.awt.Component comp)
comp
- instance of the Swing component this subclass uses to display the action parameterpublic abstract boolean wasModified(java.awt.Component comp)
comp
- instance of the Swing component this subclass uses to display the action parameterpublic java.lang.String getCapturedValues(java.util.Locale locale)
public java.lang.String getCapturedValues()
public void print()
public java.lang.String traceValue()
public java.lang.String traceString()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |