PhantomCBarControl (NetPhantom(R) 5.5 Java API documentation)

java.lang.Object
- se.entra.phantom.server.PhantomCBarControl

Direct Known Subclasses:

PhantomCBarBitmap, PhantomCBarBmpButton, PhantomCBarDateTime, PhantomCBarHostField, PhantomCBarKbdIndicator, PhantomCBarMessage, PhantomCBarSpacing, PhantomCBarStdButton, PhantomCBarText, PhantomCBarUserDraw
```
public abstract class PhantomCBarControl
extends Object
```
A Phantom Bar Control superclass that contains information about the bar controls read from the runtime file.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ADD_FRAME`
`static int`	`ALIGN_BOTTOM`
`static int`	`ALIGN_LEFT`
`static int`	`ALIGN_MASK`
`static int`	`ALIGN_RIGHT`
`static int`	`ALIGN_TOP`
`protected PhantomCBar`	`bar` The bar data
`protected int`	`barControlBGColor` Control background color (From ini file, Should this be moved to properties?).
`protected int`	`barControlFGColor` Control foreground color (From ini file, Should this be moved to properties?).
`protected int`	`barControlFont` Control font (From ini file, Should this be moved to properties?).
`static int`	`BASE_SAVE_SIZE`
`static int`	`CF_DISPLAY_HIDDEN`
`static int`	`CF_GREYOFF`
`static int`	`CF_RECTTOTEXT`
`static int`	`CF_XLATE`
`protected String`	`contents` Text contents.
`protected int`	`controlFlags` Control flags.
`protected int`	`controlType` Control type index, defined in PhantomCBar.
`protected String`	`helpID` Help ID reference.
`protected String`	`label` Control label.
`protected String`	`object` Object reference.
`static int`	`RECT_2D`
`static int`	`RECT_3D_IN`
`static int`	`RECT_3D_OUT`
`static int`	`RECT_MASK`
`static int`	`RECT_NONE`
`protected int`	`subControlType` Sub control type, for instance short time.
`protected String`	`text` Text reference.
`static int`	`TXT_JUST_CENTER`
`static int`	`TXT_JUST_MASK`
`static int`	`TXT_JUST_RIGHT`
`protected int`	`width` Width of bar control (or -1 default, -2= dynamic width).

Constructor Summary

Constructors
Constructor and Description
`PhantomCBarControl()` Empty constructor for new properties.
`PhantomCBarControl(PhantomCBar bar, PhantomFile data)` This constructor to the bar control superclass reads the general information for all bar controls: subcontrol type and control flags.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`baseSave(PhantomOutputFile file)` Saves the base data to file.
`protected int`	`convertHorzJustification()` Convert old style horizontal justification to new property justification.
`boolean`	`doDisplayHidden()` Display hidden text.
`boolean`	`doTranslate()` Do translate.
`String`	`getClientClass()` Get class name for client class.
`int`	`getConnectedControlIndex(PhantomPanelData panel, String name)` Gets the connected menu item or push button index.
`int`	`getControlFlags()` Returns the control flags
`int`	`getControlType()` Returns the control type
`void`	`getFontAndColors(IniFile ini, int index)` Loads font and color settings from the opened ini-file BARFILE.PHB.ini from the [base] section.
`String`	`getLabel()` Returns the label
`int`	`getSaveSize()` Get the size when saved to file.
`int`	`getSubControlType()` Returns the sub control type
`VirtualCBarControl`	`getVirtualControl(VirtualCBar bar, PhantomCBarControl phantomControl)` Create virtual instance that corresponds to this class.
`int`	`getWidth()` Returns the width
`boolean`	`isHeightToText()` Set rect height to text.
`abstract void`	`save(PhantomOutputFile file)` Save the instance to file.
`void`	`setControlType(int type)` Sets the control type
`void`	`setWidth(int w)` Sets the width

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

- Field Detail
  - bar
```
protected PhantomCBar bar
```
    The bar data
  - width
```
protected int width
```
    Width of bar control (or -1 default, -2= dynamic width).
  - controlType
```
protected int controlType
```
    Control type index, defined in PhantomCBar. NOTE. This may be replaced with class name in the future.
  - subControlType
```
protected int subControlType
```
    Sub control type, for instance short time. NOT FOR NEW PROPERTIES, Set flags in respective subclass.
  - RECT_3D_IN
```
public static final int RECT_3D_IN
```
    See Also:
    Constant Field Values
  - RECT_3D_OUT
```
public static final int RECT_3D_OUT
```
    See Also:
    Constant Field Values
  - RECT_2D
```
public static final int RECT_2D
```
    See Also:
    Constant Field Values
  - RECT_NONE
```
public static final int RECT_NONE
```
    See Also:
    Constant Field Values
  - RECT_MASK
```
public static final int RECT_MASK
```
    See Also:
    Constant Field Values
  - TXT_JUST_CENTER
```
public static final int TXT_JUST_CENTER
```
    See Also:
    Constant Field Values
  - TXT_JUST_RIGHT
```
public static final int TXT_JUST_RIGHT
```
    See Also:
    Constant Field Values
  - TXT_JUST_MASK
```
public static final int TXT_JUST_MASK
```
    See Also:
    Constant Field Values
  - CF_GREYOFF
```
public static final int CF_GREYOFF
```
    See Also:
    Constant Field Values
  - ADD_FRAME
```
public static final int ADD_FRAME
```
    See Also:
    Constant Field Values
  - ALIGN_BOTTOM
```
public static final int ALIGN_BOTTOM
```
    See Also:
    Constant Field Values
  - ALIGN_RIGHT
```
public static final int ALIGN_RIGHT
```
    See Also:
    Constant Field Values
  - ALIGN_TOP
```
public static final int ALIGN_TOP
```
    See Also:
    Constant Field Values
  - ALIGN_LEFT
```
public static final int ALIGN_LEFT
```
    See Also:
    Constant Field Values
  - ALIGN_MASK
```
public static final int ALIGN_MASK
```
    See Also:
    Constant Field Values
  - CF_XLATE
```
public static final int CF_XLATE
```
    See Also:
    Constant Field Values
  - CF_RECTTOTEXT
```
public static final int CF_RECTTOTEXT
```
    See Also:
    Constant Field Values
  - CF_DISPLAY_HIDDEN
```
public static final int CF_DISPLAY_HIDDEN
```
    See Also:
    Constant Field Values
  - BASE_SAVE_SIZE
```
public static final int BASE_SAVE_SIZE
```
    See Also:
    Constant Field Values
  - controlFlags
```
protected int controlFlags
```
    Control flags.
  - contents
```
protected String contents
```
    Text contents.
  - barControlFont
```
protected int barControlFont
```
    Control font (From ini file, Should this be moved to properties?).
  - barControlFGColor
```
protected int barControlFGColor
```
    Control foreground color (From ini file, Should this be moved to properties?).
  - barControlBGColor
```
protected int barControlBGColor
```
    Control background color (From ini file, Should this be moved to properties?).
  - object
```
protected String object
```
    Object reference.
  - label
```
protected String label
```
    Control label.
  - text
```
protected String text
```
    Text reference.
  - helpID
```
protected String helpID
```
    Help ID reference.
- Constructor Detail
  - PhantomCBarControl
```
public PhantomCBarControl(PhantomCBar bar,
                  PhantomFile data)
                   throws IOException
```
    This constructor to the bar control superclass reads the general information for all bar controls: subcontrol type and control flags.
    
    Throws:
    
    IOException - if an I/O error occurs.
  - PhantomCBarControl
```
public PhantomCBarControl()
```
    Empty constructor for new properties.
- Method Detail
  - baseSave
```
public void baseSave(PhantomOutputFile file)
              throws IOException
```
    Saves the base data to file.
    
    Parameters:
    file -
    
    Throws:
    
    IOException - if an I/O error occurs.
  - getFontAndColors
```
public void getFontAndColors(IniFile ini,
                    int index)
```
    Loads font and color settings from the opened ini-file BARFILE.PHB.ini from the [base] section.
  - getControlType
```
public int getControlType()
```
    Returns the control type
  - getSubControlType
```
public int getSubControlType()
```
    Returns the sub control type
  - getControlFlags
```
public int getControlFlags()
```
    Returns the control flags
  - getWidth
```
public int getWidth()
```
    Returns the width
  - getLabel
```
public String getLabel()
```
    Returns the label
  - setWidth
```
public void setWidth(int w)
```
    Sets the width
  - setControlType
```
public void setControlType(int type)
```
    Sets the control type
  - doTranslate
```
public boolean doTranslate()
```
    Do translate.
  - isHeightToText
```
public boolean isHeightToText()
```
    Set rect height to text.
  - doDisplayHidden
```
public boolean doDisplayHidden()
```
    Display hidden text.
  - convertHorzJustification
```
protected int convertHorzJustification()
```
    Convert old style horizontal justification to new property justification.
  - getConnectedControlIndex
```
public int getConnectedControlIndex(PhantomPanelData panel,
                           String name)
```
    Gets the connected menu item or push button index.
  - getClientClass
```
public String getClientClass()
```
    Get class name for client class.
  - getVirtualControl
```
public VirtualCBarControl getVirtualControl(VirtualCBar bar,
                                   PhantomCBarControl phantomControl)
```
    Create virtual instance that corresponds to this class.
  - save
```
public abstract void save(PhantomOutputFile file)
                   throws IOException
```
    Save the instance to file.
    
    Parameters:
    file -
    
    Throws:
    
    IOException
  - getSaveSize
```
public int getSaveSize()
```
    Get the size when saved to file.

Class PhantomCBarControl

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

bar

width

controlType

subControlType

RECT_3D_IN

RECT_3D_OUT

RECT_2D

RECT_NONE

RECT_MASK

TXT_JUST_CENTER

TXT_JUST_RIGHT

TXT_JUST_MASK

CF_GREYOFF

ADD_FRAME

ALIGN_BOTTOM

ALIGN_RIGHT

ALIGN_TOP

ALIGN_LEFT

ALIGN_MASK

CF_XLATE

CF_RECTTOTEXT

CF_DISPLAY_HIDDEN

BASE_SAVE_SIZE

controlFlags

contents

barControlFont

barControlFGColor

barControlBGColor

object

label

text

helpID

Constructor Detail

PhantomCBarControl

PhantomCBarControl

Method Detail

baseSave

getFontAndColors

getControlType

getSubControlType

getControlFlags

getWidth

getLabel

setWidth

setControlType

doTranslate

isHeightToText

doDisplayHidden

convertHorzJustification

getConnectedControlIndex

getClientClass

getVirtualControl

save

getSaveSize