PhantomCOutputText (NetPhantom® 8.0 Java API Specification)

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

All Implemented Interfaces:
Cloneable, PhantomControlFlags, PhantomControlType
```
public class PhantomCOutputText
extends PhantomControl
```
This class loads the control definition from the Phantom Panel file.

Field Summary

Fields
Modifier and Type	Field and Description
`int`	`clientFlags` The flags passed on to the client.
`boolean`	`doTranslate` Do use translation table flag.
`static int`	`FLAG_BACKGROUND` Background color conversion.
`static int`	`FLAG_FOCUSABLE` Focusable flag.
`static int`	`FLAG_FOREGROUND` Foreground color conversion.
`static int`	`FLAG_MNEMONIC` Mnemonic processing.
`int`	`flags` Control flags.
`int`	`font` Font index.
`PhantomHostField`	`hostField` The host field (may be null if the panel doesn't have a screen name).
`String`	`hostFieldName` The host field name.
`boolean`	`isMultiLine` Flag for multiple lines.
`int`	`justification` Justification (0x00=left, 0x01=right, 0x02=center).
`String`	`objectName` Object name.
`String`	`text` The initial text when designing a panel.

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
`PhantomCOutputText(PhantomFile data)` Creates an instance of the control class for the Designer control.
`PhantomCOutputText(PhantomFile data, PhantomPanelData panelData, int index, PhantomControlBase controlBase)` Creates an instance of the control class.
`PhantomCOutputText(PhantomPanelData panelData, PhantomControlBase controlBase, boolean isRightJustified, PhantomHostField hostField)` Creates an output text control for Gui-on-the-fly.

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.
`protected String`	`getNPObjectExtra()` Gets the "Extra" String for the NPObject.
`boolean`	`isFocusable()` Checks if the output text is focusable.
`void`	`rebind()` Re-bind the panel data.
`void`	`reloadObject()` Reload object reference.
`void`	`save(PhantomOutputFile file)` Saves an 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_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_MNEMONIC
```
public static final int FLAG_MNEMONIC
```
    Mnemonic processing.
    See Also:
    Constant Field Values
  - FLAG_FOCUSABLE
```
public static final int FLAG_FOCUSABLE
```
    Focusable flag.
    See Also:
    Constant Field Values
  - objectName
```
public String objectName
```
    Object name.
  - 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
```
    Font index.
  - justification
```
public int justification
```
    Justification (0x00=left, 0x01=right, 0x02=center). together with the flags (0x00=top, 0x04=vertical center, 0x08=bottom).
  - isMultiLine
```
public boolean isMultiLine
```
    Flag for multiple lines.
  - doTranslate
```
public boolean doTranslate
```
    Do use translation table flag.
  - flags
```
public int flags
```
    Control flags.
  - text
```
public String text
```
    The initial text when designing a panel.
  - clientFlags
```
public int clientFlags
```
    The flags passed on to the client.
- Constructor Detail
  - PhantomCOutputText
```
public PhantomCOutputText(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:
  + justification           BYTE
  + reserved                BYTE
  + initial text (skipped)  BYTE [97]
  + id                      BYTE [9]
  + object                  BYTE [9]
  + hostField               BYTE [9]
  + font                    USHORT
  + foregroundColor         BYTE
  + isMultiLine             BYTE
  + doTranslate             BYTE
  + backgroundColor         BYTE
  + flags                   BYTE
  + reserved                BYTE [9]
 
```
    Throws:
    IOException - if an I/O error occurs.
  - PhantomCOutputText
```
public PhantomCOutputText(PhantomFile data)
                   throws IOException
```
    Creates an instance of the control class for the Designer control.
    Throws:
    IOException - if an I/O error occurs.
  - PhantomCOutputText
```
public PhantomCOutputText(PhantomPanelData panelData,
                          PhantomControlBase controlBase,
                          boolean isRightJustified,
                          PhantomHostField hostField)
```
    Creates an output text control for Gui-on-the-fly.
- 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 an instance of the control class to file.
```
 Base:
  + justification           BYTE
  + reserved                BYTE
  + initial text (skipped)  BYTE [97]
  + id                      BYTE [9]
  + object                  BYTE [9]
  + hostField               BYTE [9]
  + font                    USHORT
  + foregroundColor         BYTE
  + isMultiLine             BYTE
  + doTranslate             BYTE
  + backgroundColor         BYTE
  + flags                   BYTE
  + reserved                BYTE [9]
 
```
    Specified by:
    save in class PhantomControl
    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
  - reloadObject
```
public void reloadObject()
                  throws IOException
```
    Reload object reference.
    Specified by:
    reloadObject in class PhantomControl
    Throws:
    IOException
  - 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
  - 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.
  - isFocusable
```
public boolean isFocusable()
```
    Checks if the output text is focusable.
    Returns:
    true if output text can receive focus, false otherwise.
  - 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
  - getNPObjectExtra
```
protected String getNPObjectExtra()
```
    Gets the "Extra" String for the NPObject.
    Overrides:
    getNPObjectExtra 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 PhantomCOutputText

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_FOREGROUND

FLAG_BACKGROUND

FLAG_MNEMONIC

FLAG_FOCUSABLE

objectName

hostFieldName

hostField

font

justification

isMultiLine

doTranslate

flags

text

clientFlags

Constructor Detail

PhantomCOutputText

PhantomCOutputText

PhantomCOutputText

Method Detail

rebind

save

getDataSize

reloadObject

updateGuiOnTheFlyValue

getHostFieldID

isFocusable

updateReferences

addNPObjects

getNPObjectExtra

getControlObjectID

equalsControl