com.sas.models
Interface IncrementInterface

All Known Subinterfaces:
BoundedNumberInterface
All Known Implementing Classes:
BoundedDouble, BoundedLong, IntegerRange, Scrollbar, ScrollSlider, SpinButton, SpinButton

public interface IncrementInterface

IncrementInterface describes an interface that allows a value amount to be incrementally changed using incrementBy()


Field Summary
static int BLOCK
          BLOCK increment Type identifier, used in incrementBy()
static int UNIT
          UNIT increment Type identifier used in incrementBy()
 
Method Summary
abstract  java.lang.Number getBlockIncrementNumber()
          Gets the block value increment for the IncrementInterface object.
abstract  java.lang.Number getUnitIncrementNumber()
          Gets the unit value increment for the IncrementInterface object.
abstract  java.lang.Number incrementBy(int increment, int incrementType)
          Increment, by unit or block increment amount, the current value by the specified number of increments.
abstract  void setBlockIncrementNumber(java.lang.Number block)
          Sets the block value increment for the IncrementInterface object.
abstract  void setUnitIncrementNumber(java.lang.Number unit)
          Sets the unit value increment for the IncrementInterface object.
 

Field Detail

UNIT

static final int UNIT
UNIT increment Type identifier used in incrementBy()

See Also:
Constant Field Values

BLOCK

static final int BLOCK
BLOCK increment Type identifier, used in incrementBy()

See Also:
Constant Field Values
Method Detail

incrementBy

java.lang.Number incrementBy(int increment,
                             int incrementType)
Increment, by unit or block increment amount, the current value by the specified number of increments.

Parameters:
increment - The number of incrementType(unit or block) amounts to increment the current value(can be negative to decrement value).
incrementType - UNIT to increment by the unit amount; BLOCK to increment by the block amount

getBlockIncrementNumber

java.lang.Number getBlockIncrementNumber()
Gets the block value increment for the IncrementInterface object.

Returns:
the current block increment

getUnitIncrementNumber

java.lang.Number getUnitIncrementNumber()
Gets the unit value increment for the IncrementInterface object.

Returns:
the current unit increment

setBlockIncrementNumber

void setBlockIncrementNumber(java.lang.Number block)
Sets the block value increment for the IncrementInterface object.

Parameters:
block - the block increment

setUnitIncrementNumber

void setUnitIncrementNumber(java.lang.Number unit)
Sets the unit value increment for the IncrementInterface object.

Parameters:
unit - the unit increment



Copyright © 2009 SAS Institute Inc. All Rights Reserved.