com.tivoli.twg.alertmgr
Class TWGActionParmLongSpinner

java.lang.Object
  extended bycom.tivoli.twg.alertmgr.TWGActionParm
      extended bycom.tivoli.twg.alertmgr.TWGActionParmLongSpinner

public class TWGActionParmLongSpinner
extends TWGActionParm

A class for designating that an Event Action parameter should take the form of a rotating list of long values. The spinner only allows one selection at a time.


Field Summary
 
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
TWGActionParmLongSpinner(IntelByteBuffer buf)
          Constructor for interpreting a provided IntelByteBuffer.
TWGActionParmLongSpinner(IntelByteBuffer buf, int off)
          Constructor for interpreting a provided IntelByteBuffer.
TWGActionParmLongSpinner(int idx, java.lang.String label, java.lang.String labelBundle, java.lang.String sublabel, java.lang.String sublabelBundle, long low, long high, long inc, long defaultValue)
          Constructor for a rotating list of long values action parameter where one pre-selection are made.
TWGActionParmLongSpinner(TWGActionParmLongSpinner apls)
          Copy constructor.
 
Method Summary
 java.awt.Component getGuiComponent()
          Get the graphical component associated with this TWGActionParm subclass.
 long getHighRange()
          Get the high-end value of the selectable range.
 long getIncrement()
          Get the incremental value within the selectable range.
 long getLowRange()
          Get the low-end value of the selectable range.
 long getValue()
          Get the selected value of the selectable range.
 void print()
          Print the contents of the TWGActionParmLongSpinner.
 int readTWGActionParmLongSpinner(IntelByteBuffer buf, int off)
          Constructor for interpreting a provided IntelByteBuffer.
 void saveValues(java.awt.Component spinner)
          Save the user customized value(s) of this action parameter.
 void setHighRange(long hr)
          Set the high-end value of the selectable range.
 void setIncrement(long i)
          Set the incremental value of the selectable range.
 void setLowRange(long lr)
          Set the low-end value of the selectable range.
 void setValue(long v)
          Set the selected value to the value provided.
 int sizeOf()
          Size of the object.
static int sizeOfHdr()
          Size of the header.
 int sizeOfTWGActionParmLongSpinner()
          Size of the object.
 IntelByteBuffer toIntelByteBuffer()
          Convert into IntelByteBuffer.
 boolean wasModified(java.awt.Component spinner)
          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.
 
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
 

Constructor Detail

TWGActionParmLongSpinner

public TWGActionParmLongSpinner(int idx,
                                java.lang.String label,
                                java.lang.String labelBundle,
                                java.lang.String sublabel,
                                java.lang.String sublabelBundle,
                                long low,
                                long high,
                                long inc,
                                long defaultValue)
Constructor for a rotating list of long values action parameter where one pre-selection are made.

Parameters:
label - Label (or associated bundle keyword if label bundle non-null).
low - Long defining the low-end of the values presented to the user.
high - Long defining the high-end of the values presented to the user.
inc - Long defining the increment between values presented to the user.
defaultValue - Index that references the array of choices indicating the pre-selected value.

TWGActionParmLongSpinner

public TWGActionParmLongSpinner(TWGActionParmLongSpinner apls)
Copy constructor.


TWGActionParmLongSpinner

public TWGActionParmLongSpinner(IntelByteBuffer buf)
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

TWGActionParmLongSpinner

public TWGActionParmLongSpinner(IntelByteBuffer buf,
                                int off)
Constructor for interpreting a provided IntelByteBuffer.

Method Detail

sizeOfHdr

public static int sizeOfHdr()
Size of the header.


sizeOfTWGActionParmLongSpinner

public int sizeOfTWGActionParmLongSpinner()
Size of the object.


sizeOf

public int sizeOf()
Size of the object.

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

toIntelByteBuffer

public IntelByteBuffer toIntelByteBuffer()
Convert into IntelByteBuffer.

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.

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.

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

readTWGActionParmLongSpinner

public int readTWGActionParmLongSpinner(IntelByteBuffer buf,
                                        int off)
Constructor for interpreting a provided IntelByteBuffer.


getGuiComponent

public 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 void saveValues(java.awt.Component spinner)
Save the user customized value(s) of this action parameter.

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

wasModified

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

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

getLowRange

public long getLowRange()
Get the low-end value of the selectable range.

Returns:
lowRange low-end value

setLowRange

public void setLowRange(long lr)
Set the low-end value of the selectable range.

Returns:
lr New low-end value

getHighRange

public long getHighRange()
Get the high-end value of the selectable range.

Returns:
highRange high-end value

setHighRange

public void setHighRange(long hr)
Set the high-end value of the selectable range.

Returns:
hr New high-end value

getIncrement

public long getIncrement()
Get the incremental value within the selectable range.

Returns:
incremental value

setIncrement

public void setIncrement(long i)
Set the incremental value of the selectable range.

Returns:
i New incremental value

getValue

public long getValue()
Get the selected value of the selectable range.

Returns:
current value

setValue

public void setValue(long v)
Set the selected value to the value provided.

Returns:
v New value

print

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

Overrides:
print in class TWGActionParm