PhantomCEntryField (NetPhantom® 7.7 Java API Specification)

java.lang.Object
- se.entra.phantom.server.PhantomControl
- - se.entra.phantom.server.PhantomCEntryField

All Implemented Interfaces:

Cloneable, PhantomControlFlags, PhantomControlType
```
public class PhantomCEntryField
extends PhantomControl
```
This class loads the control definition from the Phantom Panel file.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`AMOUNT_CONTROL` Date and Amount: It's an amount control.
`int`	`clientFlags` The flags #1 passed on to the client.
`static int`	`DA_MOVESIGN` Date and Amount: Move sign to beginning.
`static int`	`DA_NOTHOUSANDSEP` Date and Amount: No thousand separator.
`static int`	`DA_USEAPIRAWDATA` Date and Amount: Use raw data for API funcs.
`int`	`daFlags` Date amount: flags.
`static int`	`DATE_CONTROL` Date and Amount: It's a date control.
`int`	`decimalDateSep` Amount: decimal separator, Date: date separator.
`int`	`decimals` Amount: 0-9=fixed 255=any number.
`static int`	`DEFAULT_LENGTH` Default Entry field length.
`boolean`	`doDisableBackground` Disable background when read-only.
`boolean`	`doDisableWhenReadOnly` Disable when read only (no tab stop).
`boolean`	`doSelectField` Select entire text data when entryfield selected.
`int`	`fieldType` Field type.
`static int`	`FLAG_BACKGROUND` Background color.
`static int`	`FLAG_CLEAR` Clear next entry field.
`static int`	`FLAG_CURSORFIRST` Cursor first in field.
`static int`	`FLAG_DYNAMICWIDTH` Flag in "clientFlags" sent to the client indicating that the size of the entry field is dynamic, i.e.
`static int`	`FLAG_F_DATEAMOUNT` Date/amount control flag.
`static int`	`FLAG_FOREGROUND` Foreground color.
`static int`	`FLAG_HINDI` Hindi digits.
`static int`	`FLAG_NOCOLOR` No coloring when read only.
`static int`	`FLAG_NOSCROLL` Flag for no scroll.
`static int`	`FLAG_NOTABSTOP` No tab when read only.
`static int`	`FLAG_OUTPUTRO` Output text when read only.
`static int`	`FLAG_RTL` RTL.
`static int`	`FLAG_SELFIELD` Select all field.
`static int`	`FLAG_USERCHANGELIGHTEVENT` Should user change light-event be sent for each document change.
`int`	`flags` Flags.
`int`	`font` Field font.
`boolean`	`hasNoBorder` Flag for no border.
`boolean`	`hasNoColorWhenReadOnly` No color when read-only.
`PhantomHostField`	`hostField` The host field (may be null if the panel doesn't have a screen name).
`String`	`hostFieldName` The host field name.
`boolean`	`isAutoTab` Automatic TAB.
`boolean`	`isDirectChecked` Direct check of chars.
`boolean`	`isKeyPad` Key pad processing.
`boolean`	`isNotEmpty` Field may not be empty.
`boolean`	`isPrevEmpty` Field previously empty.
`boolean`	`isRightJustified` Flag for right justify.
`boolean`	`isUnreadable` Not readable field.
`int`	`length` Field length.
`String`	`objectName` Object name.
`int`	`pivot` Date: pivot year, used with subtype 2.
`boolean`	`setCursorFirst` Set cursor position first in field when entry field selected.
`static int`	`SIGN_ANY` Amount: plus or minus sign allowed.
`static int`	`SIGN_MINUS` Amount: minus sign only.
`static int`	`SIGN_NONE` Amount: no sign.
`static int`	`SIGN_PLUS` Amount: plus sign only.
`int`	`signDateType` Amount: SIGN_*.
`int`	`subType` Date: 0=6 digits, 1=8 digits, 2=expand to 8 digits.
`int`	`thousandSep` Amount: thousand separator, if zero (\x00) it's country setting.
`boolean`	`userChangeLightEvent` Should user change light-event be sent for each document change.

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
`PhantomCEntryField(PhantomFile data)` Designer control constructor.
`PhantomCEntryField(PhantomFile data, PhantomPanelData panelData, int index, PhantomControlBase controlBase)` Creates an instance of the control class.
`PhantomCEntryField(PhantomPanelData panelData, PhantomControlBase controlBase, int length, boolean isRightJustified, boolean isUnreadable, PhantomHostField hostField)` Creates a Gui-on-the-fly entry field.

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.
`String`	`getControlObjectID()` Needs override by the control if the `object` instance if not resolved in this class instance.
`int`	`getDataSize(PhantomOutputFile outputFile)` Get the size when saved to file.
`String`	`getHostFieldID()` Gets the host field ID for this control.
`boolean`	`isActionConnectedEnabled()` Checks if a control is action connected to another.
`void`	`rebind()` Re-bind the panel data.
`void`	`reloadObject()` Reload object reference.
`void`	`save(PhantomOutputFile file)` Saves the instance of the control class 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 java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - FLAG_NOSCROLL
```
public static final int FLAG_NOSCROLL
```
    Flag for no scroll.
    
    See Also:
    
    Constant Field Values
  - FLAG_FOREGROUND
```
public static final int FLAG_FOREGROUND
```
    Foreground color.
    
    See Also:
    
    Constant Field Values
  - FLAG_BACKGROUND
```
public static final int FLAG_BACKGROUND
```
    Background color.
    
    See Also:
    
    Constant Field Values
  - FLAG_CURSORFIRST
```
public static final int FLAG_CURSORFIRST
```
    Cursor first in field.
    
    See Also:
    
    Constant Field Values
  - FLAG_SELFIELD
```
public static final int FLAG_SELFIELD
```
    Select all field.
    
    See Also:
    
    Constant Field Values
  - FLAG_CLEAR
```
public static final int FLAG_CLEAR
```
    Clear next entry field.
    
    See Also:
    
    Constant Field Values
  - FLAG_NOTABSTOP
```
public static final int FLAG_NOTABSTOP
```
    No tab when read only.
    
    See Also:
    
    Constant Field Values
  - FLAG_NOCOLOR
```
public static final int FLAG_NOCOLOR
```
    No coloring when read only.
    
    See Also:
    
    Constant Field Values
  - FLAG_OUTPUTRO
```
public static final int FLAG_OUTPUTRO
```
    Output text when read only.
    
    See Also:
    
    Constant Field Values
  - FLAG_RTL
```
public static final int FLAG_RTL
```
    RTL.
    
    See Also:
    
    Constant Field Values
  - FLAG_HINDI
```
public static final int FLAG_HINDI
```
    Hindi digits.
    
    See Also:
    
    Constant Field Values
  - FLAG_F_DATEAMOUNT
```
public static final int FLAG_F_DATEAMOUNT
```
    Date/amount control flag.
    
    See Also:
    
    Constant Field Values
  - FLAG_USERCHANGELIGHTEVENT
```
public static final int FLAG_USERCHANGELIGHTEVENT
```
    Should user change light-event be sent for each document change.
    
    See Also:
    
    Constant Field Values
  - FLAG_DYNAMICWIDTH
```
public static final int FLAG_DYNAMICWIDTH
```
    Flag in "clientFlags" sent to the client indicating that the size of the entry field is dynamic, i.e. adjusts itself pixel-wise in width depending on the maximum input length times the maximum character width.
    
    See Also:
    
    Constant Field Values
  - DATE_CONTROL
```
public static final int DATE_CONTROL
```
    Date and Amount: It's a date control.
    
    See Also:
    
    Constant Field Values
  - AMOUNT_CONTROL
```
public static final int AMOUNT_CONTROL
```
    Date and Amount: It's an amount control.
    
    See Also:
    
    Constant Field Values
  - DA_MOVESIGN
```
public static final int DA_MOVESIGN
```
    Date and Amount: Move sign to beginning.
    
    See Also:
    
    Constant Field Values
  - DA_NOTHOUSANDSEP
```
public static final int DA_NOTHOUSANDSEP
```
    Date and Amount: No thousand separator.
    
    See Also:
    
    Constant Field Values
  - DA_USEAPIRAWDATA
```
public static final int DA_USEAPIRAWDATA
```
    Date and Amount: Use raw data for API funcs.
    
    See Also:
    
    Constant Field Values
  - SIGN_NONE
```
public static final int SIGN_NONE
```
    Amount: no sign.
    
    See Also:
    
    Constant Field Values
  - SIGN_MINUS
```
public static final int SIGN_MINUS
```
    Amount: minus sign only.
    
    See Also:
    
    Constant Field Values
  - SIGN_PLUS
```
public static final int SIGN_PLUS
```
    Amount: plus sign only.
    
    See Also:
    
    Constant Field Values
  - SIGN_ANY
```
public static final int SIGN_ANY
```
    Amount: plus or minus sign allowed.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_LENGTH
```
public static final int DEFAULT_LENGTH
```
    Default Entry field length.
    
    See Also:
    
    Constant Field Values
  - length
```
public int length
```
    Field length.
  - isRightJustified
```
public boolean isRightJustified
```
    Flag for right justify.
  - objectName
```
public String objectName
```
    Object name.
  - fieldType
```
public int fieldType
```
    Field type.
  - hostFieldName
```
public String hostFieldName
```
    The host field name.
  - hostField
```
public PhantomHostField hostField
```
    The host field (may be null if the panel doesn't have a screen name).
  - font
```
public int font
```
    Field font.
  - isUnreadable
```
public boolean isUnreadable
```
    Not readable field.
  - isNotEmpty
```
public boolean isNotEmpty
```
    Field may not be empty.
  - flags
```
public int flags
```
    Flags.
  - doDisableBackground
```
public boolean doDisableBackground
```
    Disable background when read-only.
  - isKeyPad
```
public boolean isKeyPad
```
    Key pad processing.
  - isPrevEmpty
```
public boolean isPrevEmpty
```
    Field previously empty.
  - isAutoTab
```
public boolean isAutoTab
```
    Automatic TAB.
  - hasNoBorder
```
public boolean hasNoBorder
```
    Flag for no border.
  - isDirectChecked
```
public boolean isDirectChecked
```
    Direct check of chars.
  - doDisableWhenReadOnly
```
public boolean doDisableWhenReadOnly
```
    Disable when read only (no tab stop).
  - hasNoColorWhenReadOnly
```
public boolean hasNoColorWhenReadOnly
```
    No color when read-only.
  - doSelectField
```
public boolean doSelectField
```
    Select entire text data when entryfield selected.
  - setCursorFirst
```
public boolean setCursorFirst
```
    Set cursor position first in field when entry field selected.
  - daFlags
```
public int daFlags
```
    Date amount: flags.
  - subType
```
public int subType
```
    Date: 0=6 digits, 1=8 digits, 2=expand to 8 digits.
    Amount: 0.
  - pivot
```
public int pivot
```
    Date: pivot year, used with subtype 2.
    Amount: 0.
  - decimals
```
public int decimals
```
    Amount: 0-9=fixed 255=any number.
  - signDateType
```
public int signDateType
```
    Amount: SIGN_*.
    Date: date type:
    0=system
    1=Month-Day-Year
    2=Day-Month-Year
    3=Year-Month-Day
  - decimalDateSep
```
public int decimalDateSep
```
    Amount: decimal separator, Date: date separator.
  - thousandSep
```
public int thousandSep
```
    Amount: thousand separator, if zero (\x00) it's country setting.
  - clientFlags
```
public int clientFlags
```
    The flags #1 passed on to the client.
  - userChangeLightEvent
```
public boolean userChangeLightEvent
```
    Should user change light-event be sent for each document change.
- Constructor Detail
  - PhantomCEntryField
```
public PhantomCEntryField(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:
  + length                USHORT
  + isRightJustified      BYTE
  + id                    BYTE [9]
  + object                BYTE [9]
  + fieldType             USHORT
  + hostField             BYTE [9]
  + reserved              BYTE [2]
  + font                  USHORT
  + foregroundColor       BYTE
  + isUnreadable          BYTE
  + isNotEmpty            BYTE
  + flags                 USHORT
  + reserved              BYTE
  + backgroundColor       BYTE
  + doDisableBackground   BYTE
  + isKeyPad              BYTE
  + isPrevEmpty           BYTE
  + isAutoTab             BYTE
  + hasNoBorder           BYTE
  + isDirectChecked       BYTE
 
```
    If the control has the DateAmount flag set, the following data is also read:
```
 + daFlags                ULONG
 + subType                BYTE
 + pivot                  BYTE
 + decimals               BYTE
 + signDateType           BYTE
 + decimalDateSep         BYTE
 + thousandSep            BYTE
 + reserved               BYTE [34]
 
```
    Throws:
    
    IOException - if an I/O error occurs.
  - PhantomCEntryField
```
public PhantomCEntryField(PhantomFile data)
                   throws IOException
```
    Designer control constructor.
    
    Throws:
    
    IOException - For I/O errors.
  - PhantomCEntryField
```
public PhantomCEntryField(PhantomPanelData panelData,
                          PhantomControlBase controlBase,
                          int length,
                          boolean isRightJustified,
                          boolean isUnreadable,
                          PhantomHostField hostField)
```
    Creates a Gui-on-the-fly entry field.
- Method Detail
  - rebind
```
public void rebind()
```
    Re-bind the panel data.
    
    Overrides:
    
    rebind in class PhantomControl
  - save
```
public void save(PhantomOutputFile file)
          throws IOException
```
    Saves the instance of the control class to file.
```
 Base:
  + length                USHORT
  + isRightJustified      BYTE
  + id                    BYTE [9]
  + object                BYTE [9]
  + fieldType             USHORT
  + hostField             BYTE [9]
  + reserved              BYTE [2]
  + font                  USHORT
  + foregroundColor       BYTE
  + isUnreadable          BYTE
  + isNotEmpty            BYTE
  + flags                 USHORT
  + reserved              BYTE
  + backgroundColor       BYTE
  + doDisableBackground   BYTE
  + isKeyPad              BYTE
  + isPrevEmpty           BYTE
  + isAutoTab             BYTE
  + hasNoBorder           BYTE
  + isDirectChecked       BYTE
 
```
    If the control has the DateAmount flag set, the following data is also read:
```
 + daFlags                ULONG
 + subType                BYTE
 + pivot                  BYTE
 + decimals               BYTE
 + signDateType           BYTE
 + decimalDateSep         BYTE
 + thousandSep            BYTE
 + reserved               BYTE [34]
 
```
    Specified by:
    
    save in class PhantomControl
    
    Parameters:
    
    file -
    
    Throws:
    
    IOException - if an I/O error occurs.
  - getDataSize
```
public int getDataSize(PhantomOutputFile outputFile)
```
    Get the size when saved to file.
    
    Specified by:
    
    getDataSize 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
  - reloadObject
```
public void reloadObject()
                  throws IOException
```
    Reload object reference.
    
    Specified by:
    
    reloadObject in class PhantomControl
    
    Throws:
    
    IOException
  - isActionConnectedEnabled
```
public boolean isActionConnectedEnabled()
```
    Checks if a control is action connected to another. E.g. for Copy/Paste operations.
    
    Overrides:
    
    isActionConnectedEnabled 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.
  - 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.
    
    Specified by:
    
    addNPObjects in class PhantomControl
  - 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.
    
    Specified by:
    
    equalsControl in class PhantomControl

Class PhantomCEntryField

Field Summary

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.PhantomControl

Methods inherited from class java.lang.Object

Field Detail

FLAG_NOSCROLL

FLAG_FOREGROUND

FLAG_BACKGROUND

FLAG_CURSORFIRST

FLAG_SELFIELD

FLAG_CLEAR

FLAG_NOTABSTOP

FLAG_NOCOLOR

FLAG_OUTPUTRO

FLAG_RTL

FLAG_HINDI

FLAG_F_DATEAMOUNT

FLAG_USERCHANGELIGHTEVENT

FLAG_DYNAMICWIDTH

DATE_CONTROL

AMOUNT_CONTROL

DA_MOVESIGN

DA_NOTHOUSANDSEP

DA_USEAPIRAWDATA

SIGN_NONE

SIGN_MINUS

SIGN_PLUS

SIGN_ANY

DEFAULT_LENGTH

length

isRightJustified

objectName

fieldType

hostFieldName

hostField

font

isUnreadable

isNotEmpty

flags

doDisableBackground

isKeyPad

isPrevEmpty

isAutoTab

hasNoBorder

isDirectChecked

doDisableWhenReadOnly

hasNoColorWhenReadOnly

doSelectField

setCursorFirst

daFlags

subType

pivot

decimals

signDateType

decimalDateSep

thousandSep

clientFlags

userChangeLightEvent

Constructor Detail

PhantomCEntryField

PhantomCEntryField

PhantomCEntryField

Method Detail

rebind

save

getDataSize

updateGuiOnTheFlyValue

reloadObject

isActionConnectedEnabled

getHostFieldID

updateReferences

addNPObjects

getControlObjectID

equalsControl