com.tivoli.twg.alertmgr
Class TWGActionParmText

java.lang.Object
  extended bycom.tivoli.twg.alertmgr.TWGActionParm
      extended bycom.tivoli.twg.alertmgr.TWGActionParmText
Direct Known Subclasses:
TWGActionParmTextArea, TWGActionParmTextBox

public abstract class TWGActionParmText
extends TWGActionParm

An abstract class for designating that an Event Action parameter should take the form of a simple text string.


Field Summary
static int PASSWORD
           
 
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
TWGActionParmText(IntelByteBuffer buf, int type)
          Constructor for interpreting a provided IntelByteBuffer.
TWGActionParmText(IntelByteBuffer buf, int off, int type)
          Constructor for interpreting a provided IntelByteBuffer at a given offset.
TWGActionParmText(int index, int type, java.lang.String label, java.lang.String labelBundle, java.lang.String sublabel, java.lang.String sublabelBundle, java.lang.String defaultValue, int flags)
          Constructor for a simple text string action parameter.
TWGActionParmText(TWGActionParmText apt)
          Copy constructor.
 
Method Summary
 int getFlags()
          Get the current flag settings.
abstract  java.awt.Component getGuiComponent()
          Get the graphical component associated with this TWGActionParm subclass.
 java.lang.String getValue()
          Get the selected value of the selectable range.
 boolean isaPassword()
          Check whether the text should be hidden.
 void print()
          Print the contents of the TWGActionParmText.
 int readTWGActionParmText(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 setFlags(int flg)
          Set the current flag settings.
 void setIsaPassword()
          Indicate the text should be hidden.
 void setValue(java.lang.String s)
          Set the selected value to the value provided.
 int sizeOf()
          Determine the size of the entire TWGActionParmText object
static int sizeOfHdr()
          Determine the size of the header information.
 int sizeOfTWGActionParmText()
          Determine the size of the entire TWGActionParmText object
 IntelByteBuffer toIntelByteBuffer()
          Convert the TWGActionParmText into IntelByteBuffer representation.
 java.lang.String traceValue()
           
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, unwrap, unwrap
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

PASSWORD

public static final int PASSWORD
See Also:
Constant Field Values
Constructor Detail

TWGActionParmText

public TWGActionParmText(int index,
                         int type,
                         java.lang.String label,
                         java.lang.String labelBundle,
                         java.lang.String sublabel,
                         java.lang.String sublabelBundle,
                         java.lang.String defaultValue,
                         int flags)
Constructor for a simple text string action parameter.

Parameters:
index - Index of action parameter (used as a reference key)
type - Integer encoding of subclass type
label - Label (or associated bundle keyword if label bundle non-null).
defaultValue - String indicating the default value pre-entered in the text display
flags - Flags controlling component behavior

TWGActionParmText

public TWGActionParmText(TWGActionParmText apt)
Copy constructor.


TWGActionParmText

public TWGActionParmText(IntelByteBuffer buf,
                         int type)
Constructor for interpreting a provided IntelByteBuffer. Use the current offset and start ptrs within the provided IntelByteBuffer; upon return the buffer's offset ptr is advanced to reflect the number of bytes read.

Parameters:
buf - IntelByteBuffer from which data should be read
type - Integer encoding of the TWGActionParm subclass

TWGActionParmText

public TWGActionParmText(IntelByteBuffer buf,
                         int off,
                         int type)
Constructor for interpreting a provided IntelByteBuffer at a given offset. Use the current offset and start ptrs within the provided IntelByteBuffer; upon return the buffer's start and offset ptrs are unaffected.

Parameters:
buf - IntelByteBuffer from which data should be read
off - offset from the current relative start of the provided IntelByteBuffer
type - Integer encoding of the TWGActionParm subclass
Method Detail

sizeOfHdr

public static int sizeOfHdr()
Determine the size of the header information.

Returns:
number of bytes that comprise the header

sizeOf

public int sizeOf()
Determine the size of the entire TWGActionParmText object

Overrides:
sizeOf in class TWGActionParm
Returns:
number of bytes that comprise the object

sizeOfTWGActionParmText

public int sizeOfTWGActionParmText()
Determine the size of the entire TWGActionParmText object

Returns:
number of bytes that comprise the object

toIntelByteBuffer

public IntelByteBuffer toIntelByteBuffer()
Convert the TWGActionParmText into IntelByteBuffer representation.

Specified by:
toIntelByteBuffer in class TWGActionParm
Returns:
IntelByteBuffer representing the encoded object

writeIntelByteBuffer

public int writeIntelByteBuffer(IntelByteBuffer buf)
Write contents of this object into an IntelByteBuffer. Use the current offset and start ptrs within the provided IntelByteBuffer; upon return the buffer's offset ptr is advanced to reflect the number of bytes written.

Overrides:
writeIntelByteBuffer in class TWGActionParm
Parameters:
buf - IntelByteBuffer into which data should be written
Returns:
original offset plus number of bytes written

writeIntelByteBuffer

public int writeIntelByteBuffer(IntelByteBuffer buf,
                                int off)
Write action parm into provided IntelByteBuffer starting at a given offset. Use the current offset and start ptrs within the provided IntelByteBuffer to determine a relative start ptr and begin writing off bytes from that location. Return the buffer's offset ptr advanced to reflect the number of bytes written.

Overrides:
writeIntelByteBuffer in class TWGActionParm
Parameters:
buf - IntelByteBuffer into which data should be written
off - offset from the current relative start of the provided IntelByteBuffer
Returns:
number of bytes written

readTWGActionParmText

public int readTWGActionParmText(IntelByteBuffer buf,
                                 int off,
                                 int type)
Method for interpreting a provided IntelByteBuffer at a given offset.

Parameters:
buf - IntelByteBuffer from which TWGActionParm should be read
off - offset from the current relative start of the provided IntelByteBuffer
type - Integer encoding of the TWGActionParm subclass
Returns:
number of bytes read while interpreting the buffer

getGuiComponent

public abstract java.awt.Component getGuiComponent()
Get the graphical component associated with this TWGActionParm subclass.

Specified by:
getGuiComponent in class TWGActionParm
Returns:
Swing component this subclass uses to display the action parameter

saveValues

public abstract void saveValues(java.awt.Component comp)
Save the user customized value(s) of this action parameter.

Specified by:
saveValues in class TWGActionParm
Parameters:
comp - instance of the Swing component this subclass uses to display the action parameter

wasModified

public abstract boolean wasModified(java.awt.Component comp)
Determine if the user modified the value(s) of this action parameter.

Specified by:
wasModified in class TWGActionParm
Parameters:
comp - instance of the Swing component this subclass uses to display the action parameter

setIsaPassword

public void setIsaPassword()
Indicate the text should be hidden.


isaPassword

public boolean isaPassword()
Check whether the text should be hidden.


getFlags

public int getFlags()
Get the current flag settings.

Returns:
current flags

setFlags

public void setFlags(int flg)
Set the current flag settings.

Parameters:
flg - New flags

getValue

public java.lang.String getValue()
Get the selected value of the selectable range.

Returns:
current value

setValue

public void setValue(java.lang.String s)
Set the selected value to the value provided.

Returns:
v New value

print

public void print()
Print the contents of the TWGActionParmText.

Overrides:
print in class TWGActionParm

traceValue

public java.lang.String traceValue()
Overrides:
traceValue in class TWGActionParm