PhantomCSpinButton (NetPhantom® 8.0 Java API Specification)

java.lang.Object
- se.entra.phantom.server.PhantomControl
- - se.entra.phantom.server.PhantomListCapableControl
  - - se.entra.phantom.server.PhantomCSpinButton

All Implemented Interfaces:
Cloneable, IListCapableControl, PhantomControlFlags, PhantomControlType
```
public class PhantomCSpinButton
extends PhantomListCapableControl
implements IListCapableControl
```
This class loads the control definition from the Phantom Panel file.

Field Summary

Fields
Modifier and Type	Field and Description
`int`	`createSBFlag` Creation flags for client.
`int`	`fieldType` field type.
`static int`	`FLAG_BACKGROUND` Background color conversion.
`static int`	`FLAG_FILENAME` File name flag.
`static int`	`FLAG_FOREGROUND` Foreground color conversion.
`static int`	`FLAG_SORTLIST` List is sorted.
`static int`	`FLAG_USERCHGLIGHTEVENT` User change light event on all document changes.
`int`	`flags` flags.
`int`	`font` font
`boolean`	`hasNoBorder` No border for spin button flag
`boolean`	`hasNoUserInput` No user input flag.
`boolean`	`hasValueRange` Has value Range flag.
`PhantomHostField`	`hostField` The host field name.
`String`	`hostFieldName` The host field (may be null if the panel doesn't have a screen name).
`boolean`	`isDirectChecked` Direct Checked flag.
`boolean`	`isFastSpin` Fast Spin Button flag.
`boolean`	`isNumericOnly` Numeric only flag.
`boolean`	`isRightJustified` is Right Justified flag.
`boolean`	`isZeroPad` Zero Padding flag.
`int`	`length` length.
`String`	`masterID` Master ID field ID.
`int`	`masterIndex` The Master ID control index (or -1 if not found).
`int`	`maxValue` maximum Value.
`int`	`minValue` minimum Value.
`int`	`newFlags` new flags.
`String`	`objectName` Object name.
`int`	`stepValue` Stepping value.

Fields inherited from class se.entra.phantom.server.PhantomListCapableControl
isHostConverted, isSorted

Fields inherited from class se.entra.phantom.server.PhantomControl
controlBase, controlColor, id, index, isBackgroundConverted, isForegroundConverted, object, panelData, popupMenu, tooltipText

Fields inherited from interface se.entra.phantom.server.PhantomControlType
CTRLTYPE_BUTTON, CTRLTYPE_CHECK, CTRLTYPE_COMBO, CTRLTYPE_FRAME, CTRLTYPE_GRAPH, CTRLTYPE_GROUP, CTRLTYPE_INOUT, CTRLTYPE_LIST, CTRLTYPE_MLE, CTRLTYPE_NOTE, CTRLTYPE_OUT, CTRLTYPE_RADIO, CTRLTYPE_RECT, CTRLTYPE_SPIN, CTRLTYPE_SUB, CTRLTYPE_TEXT, CTRLTYPE_TREE, CTRLTYPE_UNKNOWN, CTRLTYPE_USER, CTRLTYPES_COUNT, names

Fields inherited from interface se.entra.phantom.server.PhantomControlFlags
CTRLFLAG_MOVEX, CTRLFLAG_MOVEY, CTRLFLAG_NEWGROUP, CTRLFLAG_SIZEX, CTRLFLAG_SIZEY, CTRLFLAG_SUBWIN, CTRLFLAG_TABSTOP, CTRLFLAG_TRANSPARENT

Constructor Summary

Constructors
Constructor and Description
`PhantomCSpinButton(PhantomFile data)` Constructor for the Designer control.
`PhantomCSpinButton(PhantomFile data, PhantomPanelData panelData, int index, PhantomControlBase controlBase)` Creates an instance of the control class.
`PhantomCSpinButton(PhantomPanelData panelData, PhantomControlBase controlBase, PhantomHostField hostField, int[] range)` GUI-on-the-fly constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addNPObjects(ENPObject obj)` Gets the NPObject for the control.
`protected boolean`	`equalsControl(PhantomControl c)` Checks for control equality.
`protected int`	`getBaseDataSize()` Gets the base data size of the extending control.
`String`	`getControlObjectID()` Needs override by the control if the `object` instance if not resolved in this class instance.
`int`	`getFieldType()` Gets the field type.
`int`	`getFont()` Gets the font.
`PhantomHostField`	`getHostField()` Gets the host field.
`String`	`getHostFieldID()` Gets the host field ID for this control.
`String`	`getHostFieldName()` Gets the host field name.
`String`	`getID()` Gets the ID.
`int`	`getLength()` Gets the length of the entry field.
`PhantomObject`	`getObject()` Gets the object, null for none.
`boolean`	`hasFileName()` Checks for filename.
`boolean`	`hasValueRange()` Checks for value range, spin button only.
`boolean`	`isActionConnectedEnabled()` Checks if a control is action connected to another.
`boolean`	`isCaseSensitive()` Case sensitive sorting (always true).
`boolean`	`isDirectChecked()` Check for direct-checked when user types a character.
`boolean`	`isNeverDisabled()` Should control never be disabled (always false).
`void`	`rebind()` Re-bind the panel data.
`void`	`reloadObject()` Reload object reference.
`void`	`resolveComponentReferences()` Resolves reference of this control to spin button master, after the panel has been loaded.
`void`	`save(PhantomOutputFile file)` Saves the instance of the control to file.
`void`	`updateGuiOnTheFlyValue(CRC32 crc32)` Updates the CRC32 value of a Gui-on-the-fly value with the control's base data.
`void`	`updateReferences(ApplicationReferences refs)` Updates the Applications References instance.

Methods inherited from class se.entra.phantom.server.PhantomListCapableControl
getContentSize, getDataSize, getFileListContent, getListContent, getListConversion, getLists, getLists, getLists, getLists, getReferencedFiles, isSorted, loadContents, saveContents, updateReferences

Methods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface se.entra.phantom.server.IListCapableControl
getBackgroundColor, getFileListContent, getForegroundColor, getLists, isSorted, processColorConversion

- Field Detail
  - FLAG_FOREGROUND
```
public static final int FLAG_FOREGROUND
```
    Foreground color conversion.
    See Also:
    Constant Field Values
  - FLAG_BACKGROUND
```
public static final int FLAG_BACKGROUND
```
    Background color conversion.
    See Also:
    Constant Field Values
  - FLAG_FILENAME
```
public static final int FLAG_FILENAME
```
    File name flag.
    See Also:
    Constant Field Values
  - FLAG_USERCHGLIGHTEVENT
```
public static final int FLAG_USERCHGLIGHTEVENT
```
    User change light event on all document changes.
    See Also:
    Constant Field Values
  - FLAG_SORTLIST
```
public static final int FLAG_SORTLIST
```
    List is sorted.
    See Also:
    Constant Field Values
  - hostField
```
public PhantomHostField hostField
```
    The host field name.
  - hostFieldName
```
public String hostFieldName
```
    The host field (may be null if the panel doesn't have a screen name).
  - objectName
```
public String objectName
```
    Object name.
  - masterID
```
public String masterID
```
    Master ID field ID.
  - masterIndex
```
public int masterIndex
```
    The Master ID control index (or -1 if not found).
  - isRightJustified
```
public boolean isRightJustified
```
    is Right Justified flag.
  - hasNoUserInput
```
public boolean hasNoUserInput
```
    No user input flag.
  - hasValueRange
```
public boolean hasValueRange
```
    Has value Range flag.
  - isFastSpin
```
public boolean isFastSpin
```
    Fast Spin Button flag.
  - hasNoBorder
```
public boolean hasNoBorder
```
    No border for spin button flag
  - isZeroPad
```
public boolean isZeroPad
```
    Zero Padding flag.
  - isNumericOnly
```
public boolean isNumericOnly
```
    Numeric only flag.
  - minValue
```
public int minValue
```
    minimum Value.
  - maxValue
```
public int maxValue
```
    maximum Value.
  - stepValue
```
public int stepValue
```
    Stepping value.
  - length
```
public int length
```
    length.
  - font
```
public int font
```
    font
  - isDirectChecked
```
public boolean isDirectChecked
```
    Direct Checked flag.
  - fieldType
```
public int fieldType
```
    field type.
  - flags
```
public int flags
```
    flags.
  - newFlags
```
public int newFlags
```
    new flags.
  - createSBFlag
```
public int createSBFlag
```
    Creation flags for client.
- Constructor Detail
  - PhantomCSpinButton
```
public PhantomCSpinButton(PhantomFile data,
                          PhantomPanelData panelData,
                          int index,
                          PhantomControlBase controlBase)
                   throws IOException
```
    Creates an instance of the control class. Loads the data from a Phantom Panel file that has previously been read into memory.
```
 Base:
  + id                                                BYTE[9]
  + object                                          BYTE[9]
  + hostField                               BYTE[9]
  + masterID                                BYTE[9]
  + reserved                                BYTE[2]
  + isRightJustified      BYTE
  + hasNoUserInput                BYTE
  + hasValueRange                   BYTE
  + isFastSpin                      BYTE
  + useHostConversion     BYTE
  + hasNoBorder                     BYTE
  + isZeroPad                               BYTE
  + isNumericOnly                   BYTE
  + listSize                                USHORT
  + minValue                                LONG
  + maxValue                                LONG
  + stepValue                               LONG
  + length                                          USHORT
  + font                                              USHORT
  + foregroundColor               BYTE
  + isDirectChecked               BYTE
  + fieldType                               USHORT
  + flags                                             BYTE
  + newFlags                                USHORT
  + reserved                                BYTE[10]
 
```
    Throws:
    IOException - if an I/O error occurs.
  - PhantomCSpinButton
```
public PhantomCSpinButton(PhantomFile data)
                   throws IOException
```
    Constructor for the Designer control.
    Throws:
    IOException - For I/O errors.
  - PhantomCSpinButton
```
public PhantomCSpinButton(PhantomPanelData panelData,
                          PhantomControlBase controlBase,
                          PhantomHostField hostField,
                          int[] range)
```
    GUI-on-the-fly constructor.
- Method Detail
  - hasFileName
```
public boolean hasFileName()
```
    Checks for filename.
    Specified by:
    hasFileName in class PhantomListCapableControl
  - getBaseDataSize
```
protected int getBaseDataSize()
```
    Gets the base data size of the extending control.
    Specified by:
    getBaseDataSize in class PhantomListCapableControl
  - rebind
```
public void rebind()
```
    Re-bind the panel data.
    Overrides:
    rebind in class PhantomControl
  - updateGuiOnTheFlyValue
```
public void updateGuiOnTheFlyValue(CRC32 crc32)
```
    Updates the CRC32 value of a Gui-on-the-fly value with the control's base data.
    All controls that implements a Gui-on-the-fly constructor must always override this method and start by calling super.updateGuiOnTheFlyCRC32(crc32) before adding control specific data.
    Overrides:
    updateGuiOnTheFlyValue in class PhantomControl
  - resolveComponentReferences
```
public void resolveComponentReferences()
```
    Resolves reference of this control to spin button master, after the panel has been loaded.
    Overrides:
    resolveComponentReferences in class PhantomControl
  - getHostFieldID
```
public String getHostFieldID()
```
    Gets the host field ID for this control.
    Overrides:
    getHostFieldID in class PhantomControl
    Returns:
    String may be of zero-length if no host field ID is defined.
  - isActionConnectedEnabled
```
public boolean isActionConnectedEnabled()
```
    Checks if a control is action connected to another. E.g. for Copy/Paste operations.
    Overrides:
    isActionConnectedEnabled in class PhantomControl
  - save
```
public void save(PhantomOutputFile file)
          throws IOException
```
    Saves the instance of the control to file.
```
 Base:
  + id                  BYTE[9]
  + object              BYTE[9]
  + hostField           BYTE[9]
  + masterID            BYTE[9]
  + reserved            BYTE[2]
  + isRightJustified    BYTE
  + hasNoUserInput      BYTE
  + hasValueRange       BYTE
  + isFastSpin          BYTE
  + useHostConversion   BYTE
  + hasNoBorder         BYTE
  + isZeroPad           BYTE
  + isNumericOnly       BYTE
  + listSize            USHORT
  + minValue            LONG
  + maxValue            LONG
  + stepValue           LONG
  + length              USHORT
  + font                USHORT
  + foregroundColor     BYTE
  + isDirectChecked     BYTE
  + fieldType           USHORT
  + flags               BYTE
  + newFlags            USHORT
  + reserved            BYTE[10]
 
```
    Specified by:
    save in class PhantomControl
    Parameters:
    file -
    Throws:
    IOException - if an I/O error occurs.
  - reloadObject
```
public void reloadObject()
                  throws IOException
```
    Reload object reference.
    Specified by:
    reloadObject in class PhantomControl
    Throws:
    IOException
  - getID
```
public String getID()
```
    Gets the ID.
    Specified by:
    getID in interface IListCapableControl
    Overrides:
    getID in class PhantomControl
  - getLength
```
public int getLength()
```
    Gets the length of the entry field.
    Specified by:
    getLength in interface IListCapableControl
  - getFieldType
```
public int getFieldType()
```
    Gets the field type.
    Specified by:
    getFieldType in interface IListCapableControl
  - isDirectChecked
```
public boolean isDirectChecked()
```
    Check for direct-checked when user types a character.
    Specified by:
    isDirectChecked in interface IListCapableControl
  - getObject
```
public PhantomObject getObject()
```
    Gets the object, null for none.
    Specified by:
    getObject in interface IListCapableControl
    Overrides:
    getObject in class PhantomControl
  - getFont
```
public int getFont()
```
    Gets the font.
    Specified by:
    getFont in interface IListCapableControl
  - getHostField
```
public PhantomHostField getHostField()
```
    Gets the host field.
    Specified by:
    getHostField in interface IListCapableControl
  - getHostFieldName
```
public String getHostFieldName()
```
    Gets the host field name.
    Specified by:
    getHostFieldName in interface IListCapableControl
  - isCaseSensitive
```
public boolean isCaseSensitive()
```
    Case sensitive sorting (always true).
    Specified by:
    isCaseSensitive in interface IListCapableControl
  - hasValueRange
```
public boolean hasValueRange()
```
    Checks for value range, spin button only.
    Specified by:
    hasValueRange in interface IListCapableControl
  - isNeverDisabled
```
public boolean isNeverDisabled()
```
    Should control never be disabled (always false).
    Specified by:
    isNeverDisabled in interface IListCapableControl
  - updateReferences
```
public void updateReferences(ApplicationReferences refs)
```
    Updates the Applications References instance.
    Specified by:
    updateReferences in class PhantomControl
  - addNPObjects
```
protected void addNPObjects(ENPObject obj)
```
    Gets the NPObject for the control.
    Overrides:
    addNPObjects in class PhantomListCapableControl
  - getControlObjectID
```
public String getControlObjectID()
```
    Needs override by the control if the object instance if not resolved in this class instance.
    Overrides:
    getControlObjectID in class PhantomControl
    Returns:
    the Object ID connected to this control, null or empty string for none.
  - equalsControl
```
protected boolean equalsControl(PhantomControl c)
```
    Checks for control equality. The base is already checked and the Control ID, potential fore- and background color and color conversion flags. The tooltip text is not checked.
    Overrides:
    equalsControl in class PhantomListCapableControl

Class PhantomCSpinButton

Field Summary

Fields inherited from class se.entra.phantom.server.PhantomListCapableControl

Fields inherited from class se.entra.phantom.server.PhantomControl

Fields inherited from interface se.entra.phantom.server.PhantomControlType

Fields inherited from interface se.entra.phantom.server.PhantomControlFlags

Constructor Summary

Method Summary

Methods inherited from class se.entra.phantom.server.PhantomListCapableControl

Methods inherited from class se.entra.phantom.server.PhantomControl

Methods inherited from class java.lang.Object

Methods inherited from interface se.entra.phantom.server.IListCapableControl

Field Detail

FLAG_FOREGROUND

FLAG_BACKGROUND

FLAG_FILENAME

FLAG_USERCHGLIGHTEVENT

FLAG_SORTLIST

hostField

hostFieldName

objectName

masterID

masterIndex

isRightJustified

hasNoUserInput

hasValueRange

isFastSpin

hasNoBorder

isZeroPad

isNumericOnly

minValue

maxValue

stepValue

length

font

isDirectChecked

fieldType

flags

newFlags

createSBFlag

Constructor Detail

PhantomCSpinButton

PhantomCSpinButton

PhantomCSpinButton

Method Detail

hasFileName

getBaseDataSize

rebind

updateGuiOnTheFlyValue

resolveComponentReferences

getHostFieldID

isActionConnectedEnabled

save

reloadObject

getID

getLength

getFieldType

isDirectChecked

getObject

getFont

getHostField

getHostFieldName

isCaseSensitive

hasValueRange

isNeverDisabled

updateReferences

addNPObjects

getControlObjectID

equalsControl