PhantomCBar (NetPhantom(R) 5.5 Java API documentation)

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

All Implemented Interfaces:

IReloadable
```
public class PhantomCBar
extends Object
implements IReloadable
```
A Phantom Bar class that contains information about the bar and the bar controls read from the runtime file.

Field Summary

Fields
Modifier and Type	Field and Description
`Vector<PhantomCBarControl>`	`barControls` The bar controls
`FileChangedChecker`	`configuration` The configuration data
`String`	`fileName` The file name of the BAR (not including .PHB file extension), or null if in-memory.
`static int`	`FLAG_BITMAP` Bar control bitmap type
`static int`	`FLAG_BMPBUTTON` Bar control bitmap button type
`static int`	`FLAG_CAPSLOCK_SUBTYPE`
`static int`	`FLAG_CUSTOMDT_SUBTYPE`
`static int`	`FLAG_DATETIME` Bar control date time type and subtypes
`static int`	`FLAG_HOSTFLD_TYPE` Bar control hostfield type
`static int`	`FLAG_INSERT_SUBTYPE`
`static int`	`FLAG_KBDIND_TYPE` Bar control keyboard indicator type and subtypes
`static int`	`FLAG_LARROW_SUBTYPE`
`static int`	`FLAG_LDATE_SUBTYPE`
`static int`	`FLAG_LTIME_SUBTYPE`
`static int`	`FLAG_MSG_TYPE` Bar control message type
`static int`	`FLAG_NUMLOCK_SUBTYPE`
`static int`	`FLAG_QUESTION_SUBTYPE`
`static int`	`FLAG_RARROW_SUBTYPE`
`static int`	`FLAG_SCRLOCK_SUBTYPE`
`static int`	`FLAG_SDATE_SUBTYPE`
`static int`	`FLAG_SPACING` Bar control spacing type
`static int`	`FLAG_STDBUTTON` Bar control standard button type and subtypes
`static int`	`FLAG_STIME_SUBTYPE`
`static int`	`FLAG_TEXT_TYPE` Bar control text type
`static int`	`FLAG_USERDRAW` Bar control user draw type
`static int`	`globalFileIndex` New property global file name index.
`boolean`	`isTemplate` The flag that indicates if this instance is saved in templatefile or in a PhantomPanel.

Fields inherited from interface se.entra.phantom.server.IReloadable
FAILURE, NOTHING_DONE, SUCCESS

Constructor Summary

Constructors
Constructor and Description
`PhantomCBar()` Empty constructor for dynamic load.
`PhantomCBar(PhantomControl bd, PhantomFile data, String newFilename)` Constructor.

Method Summary

Methods
Modifier and Type	Method and Description
`static PhantomCBar`	`createPhantomBar(PhantomControl bd, PhantomCUserWindow uw, PhantomFile data)` This method returns a bar object if it's already loaded or loads it from file.
`PhantomCBarControl`	`getBarControl(String label)` Methods that returns the bar control with the specified argument label, which is either the label of the object or the index to the object
`Vector<PhantomCBarControl>`	`getBarControls()` Returns the bar controls
`PhantomCBarControl`	`getControlWithLabel(String label)` Method that returns the bar control object specified by the label argument Called from fetchBarControl
`int`	`getCreateFlags()` Returns the create flags
`int`	`getFontSize()` Returns the font size
`PhantomHostField`	`getHostField(String hostFieldName)` Returns the host field or null if bar is template.
`PhantomObject`	`getObject(String objectName, String referer)` Returns the object or null if bar is template.
`int`	`getRefSaveSize()` Get the size when reference is saved to file.
`int`	`getSaveSize()` Get the size.
`void`	`load(PhantomControl bd, PhantomFile data, String newFilename)` Creates an instance of the control class.
`boolean`	`needsReload()` Check if this file needs to be reloaded.
`int`	`reload(boolean force)` Reload internal state from external sources.
`void`	`save(PhantomOutputFile file)` Saves the instance of the control class to file.
`void`	`save(String namedFile)` Saves the bar to a named file.
`void`	`saveRef(PhantomOutputFile file)` This method saves the bar object to file.

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

Field Detail
- configuration
```
public FileChangedChecker configuration
```
  The configuration data
- barControls
```
public Vector<PhantomCBarControl> barControls
```
  The bar controls
- fileName
```
public String fileName
```
  The file name of the BAR (not including .PHB file extension), or null if in-memory.
- isTemplate
```
public boolean isTemplate
```
  The flag that indicates if this instance is saved in templatefile or in a PhantomPanel.
- FLAG_MSG_TYPE
```
public static final int FLAG_MSG_TYPE
```
  Bar control message type
  
  See Also:
  Constant Field Values
- FLAG_TEXT_TYPE
```
public static final int FLAG_TEXT_TYPE
```
  Bar control text type
  
  See Also:
  Constant Field Values
- FLAG_HOSTFLD_TYPE
```
public static final int FLAG_HOSTFLD_TYPE
```
  Bar control hostfield type
  
  See Also:
  Constant Field Values
- FLAG_KBDIND_TYPE
```
public static final int FLAG_KBDIND_TYPE
```
  Bar control keyboard indicator type and subtypes
  
  See Also:
  Constant Field Values
- FLAG_CAPSLOCK_SUBTYPE
```
public static final int FLAG_CAPSLOCK_SUBTYPE
```
  See Also:
  Constant Field Values
- FLAG_NUMLOCK_SUBTYPE
```
public static final int FLAG_NUMLOCK_SUBTYPE
```
  See Also:
  Constant Field Values
- FLAG_SCRLOCK_SUBTYPE
```
public static final int FLAG_SCRLOCK_SUBTYPE
```
  See Also:
  Constant Field Values
- FLAG_INSERT_SUBTYPE
```
public static final int FLAG_INSERT_SUBTYPE
```
  See Also:
  Constant Field Values
- FLAG_DATETIME
```
public static final int FLAG_DATETIME
```
  Bar control date time type and subtypes
  
  See Also:
  Constant Field Values
- FLAG_STIME_SUBTYPE
```
public static final int FLAG_STIME_SUBTYPE
```
  See Also:
  Constant Field Values
- FLAG_LTIME_SUBTYPE
```
public static final int FLAG_LTIME_SUBTYPE
```
  See Also:
  Constant Field Values
- FLAG_SDATE_SUBTYPE
```
public static final int FLAG_SDATE_SUBTYPE
```
  See Also:
  Constant Field Values
- FLAG_LDATE_SUBTYPE
```
public static final int FLAG_LDATE_SUBTYPE
```
  See Also:
  Constant Field Values
- FLAG_CUSTOMDT_SUBTYPE
```
public static final int FLAG_CUSTOMDT_SUBTYPE
```
  See Also:
  Constant Field Values
- FLAG_STDBUTTON
```
public static final int FLAG_STDBUTTON
```
  Bar control standard button type and subtypes
  
  See Also:
  Constant Field Values
- FLAG_LARROW_SUBTYPE
```
public static final int FLAG_LARROW_SUBTYPE
```
  See Also:
  Constant Field Values
- FLAG_RARROW_SUBTYPE
```
public static final int FLAG_RARROW_SUBTYPE
```
  See Also:
  Constant Field Values
- FLAG_QUESTION_SUBTYPE
```
public static final int FLAG_QUESTION_SUBTYPE
```
  See Also:
  Constant Field Values
- FLAG_BMPBUTTON
```
public static final int FLAG_BMPBUTTON
```
  Bar control bitmap button type
  
  See Also:
  Constant Field Values
- FLAG_BITMAP
```
public static final int FLAG_BITMAP
```
  Bar control bitmap type
  
  See Also:
  Constant Field Values
- FLAG_USERDRAW
```
public static final int FLAG_USERDRAW
```
  Bar control user draw type
  
  See Also:
  Constant Field Values
- FLAG_SPACING
```
public static final int FLAG_SPACING
```
  Bar control spacing type
  
  See Also:
  Constant Field Values
- globalFileIndex
```
public static int globalFileIndex
```
  New property global file name index.

Constructor Detail

PhantomCBar

public PhantomCBar(PhantomControl bd,
           PhantomFile data,
           String newFilename)
            throws IOException

Constructor.

Throws:: IOException

PhantomCBar
```
public PhantomCBar()
```
Empty constructor for dynamic load.

Method Detail

load

public void load(PhantomControl bd,
        PhantomFile data,
        String newFilename)
          throws IOException

Creates an instance of the control class. Loads the data from a Phantom Panel file that has previously been read into memory.

  Read:
    Header information
    + Signature                                   BYTE [3]
    + Version                                     BYTE
    + Size of description                         USHORT
    + Size of data                                USHORT
    + Filler (for WIN16)                          USHORT
    + Description                                 [Size of description]

    Bar information
    + Bar data size                               USHORT

    Bar data
    + Create flags                                ULONG
    + Dirty                                       LONG
    + Country code                                LONG
    + Country index                               LONG
    + Rectangle for bar                           RECTL [8 x ULONG]
    + Font                                        PSZ
    + Font size                                   LONG
    + Max no of characters in Caps                LONG
    + Max no of characters in Num                 LONG
    + Max no of characters in Scrl                LONG
    + Max no of characters in Ins                 LONG
    + Min width for chars in dynamic controls     LONG
    + Min dyn                                     LONG
    + System border Width/Height                  LONG
    + System border Width/Height * 2              LONG
    + System border Width/Height * 3              LONG
    + System border Width/Height * 8              LONG
    + System border Width/Height * 9              LONG
    + Bar height                                  LONG
    + Char ?                                      LONG
    + Font used in status bar                     ULONG
    + Handle to user window                       ULONG
    + First keyboard indicator (-1 if none)       SHORT
    + First host connected field (-1 if none)     SHORT
    + First date time field (-1 if none)          LONG
    + Field for keyboard hook                     LONG
    + Number of bar controls                      LONG
    + Bar controls                                PBAR_CTL
    + Id of user window                           BYTE [16]
    + Bar object call on create and destroy       BYTE [9]

    Font information
    + Font size                                   USHORT
    + Font name                                   [Size of font name]
    
    Bar control information
    + Bar control data size                       USHORT
    
    Bar control data
    + Rectangle for bar control                   RECTL [8 x ULONG]
    + Width                                       LONG
    + Width in pixels                             LONG
    + Type of control                             LONG
    + Sub type of control                         LONG
    + Control flags                               ULONG
    + Object ID                                   PSZ
    + Label of control                            PSZ
    + Control dependent text                      PSZ
    + Help ID (Only buttons)                      PSZ
    + Current text contents                       BYTE [81]
    + State (Control dependent usage)             LONG
    + Data (Control dependent usage)              PVOID

Throws:: IOException - if an I/O error occurs.

save
```
public void save(String namedFile)
          throws IOException
```
Saves the bar to a named file.

Parameters:
namedFile -

Throws:

IOException

save

public void save(PhantomOutputFile file)
          throws IOException

Saves the instance of the control class to file.

  Read:
    Header information
    + Signature                                   BYTE [3]
    + Version                                     BYTE
    + Size of description                         USHORT
    + Size of data                                USHORT
    + Filler (for WIN16)                          USHORT
    + Description                                 [Size of description]

    Bar information
    + Bar data size                               USHORT

    Bar data
    + Create flags                                ULONG
    + Dirty                                       LONG
    + Country code                                LONG
    + Country index                               LONG
    + Rectangle for bar                           RECTL [8 x ULONG]
    + Font                                        PSZ
    + Font size                                   LONG
    + Max no of characters in Caps                LONG
    + Max no of characters in Num                 LONG
    + Max no of characters in Scrl                LONG
    + Max no of characters in Ins                 LONG
    + Min width for chars in dynamic controls     LONG
    + Min dyn                                     LONG
    + System border Width/Height                  LONG
    + System border Width/Height * 2              LONG
    + System border Width/Height * 3              LONG
    + System border Width/Height * 8              LONG
    + System border Width/Height * 9              LONG
    + Bar height                                  LONG
    + Char ?                                      LONG
    + Font used in status bar                     ULONG
    + Handle to user window                       ULONG
    + First keyboard indicator (-1 if none)       SHORT
    + First host connected field (-1 if none)     SHORT
    + First date time field (-1 if none)          LONG
    + Field for keyboard hook                     LONG
    + Number of bar controls                      LONG
    + Bar controls                                PBAR_CTL
    + Id of user window                           BYTE [16]
    + Bar object call on create and destroy       BYTE [9]

    Font information
    + Font size                                   USHORT
    + Font name                                   [Size of font name]
    
    Bar control information
    + Bar control data size                       USHORT
    
    Bar control data
    + Rectangle for bar control                   RECTL [8 x ULONG]
    + Width                                       LONG
    + Width in pixels                             LONG
    + Type of control                             LONG
    + Sub type of control                         LONG
    + Control flags                               ULONG
    + Object ID                                   PSZ
    + Label of control                            PSZ
    + Control dependent text                      PSZ
    + Help ID (Only buttons)                      PSZ
    + Current text contents                       BYTE [81]
    + State (Control dependent usage)             LONG
    + Data (Control dependent usage)              PVOID

Parameters:: file -
Throws:: IOException - if an I/O error occurs.

createPhantomBar

public static PhantomCBar createPhantomBar(PhantomControl bd,
                           PhantomCUserWindow uw,
                           PhantomFile data)
                                    throws IOException

This method returns a bar object if it's already loaded or loads it from file.

Throws:: IOException - if an I/O error occurs.

saveRef
```
public void saveRef(PhantomOutputFile file)
             throws IOException
```
This method saves the bar object to file.

Parameters:
file -

Throws:

IOException - if an I/O error occurs.

getRefSaveSize
```
public int getRefSaveSize()
```
Get the size when reference is saved to file.

getSaveSize
```
public int getSaveSize()
```
Get the size.

getCreateFlags
```
public int getCreateFlags()
```
Returns the create flags

getFontSize
```
public int getFontSize()
```
Returns the font size

getBarControls

public Vector<PhantomCBarControl> getBarControls()

Returns the bar controls

getHostField

public PhantomHostField getHostField(String hostFieldName)

Returns the host field or null if bar is template.

getObject

public PhantomObject getObject(String objectName,
                      String referer)
                        throws IOException

Returns the object or null if bar is template.

Throws:: IOException

getBarControl
```
public PhantomCBarControl getBarControl(String label)
```
Methods that returns the bar control with the specified argument label, which is either the label of the object or the index to the object

Parameters:
label - either a label string, or an index to a bar control

Returns:
the PhantomCBarControl object if existing else null

getControlWithLabel
```
public PhantomCBarControl getControlWithLabel(String label)
```
Method that returns the bar control object specified by the label argument Called from fetchBarControl

Parameters:
label - the label of the bar control that should be searched for

Returns:
the VirtualCBarControl object if existing else null

needsReload
```
public boolean needsReload()
```
Check if this file needs to be reloaded.

Specified by:

needsReload in interface IReloadable

Returns:
boolean

reload
```
public int reload(boolean force)
           throws IOException
```
Reload internal state from external sources.

Specified by:

reload in interface IReloadable

Parameters:
force - - force the reload.

Returns:
int

Throws:

IOException

Class PhantomCBar

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

configuration

barControls

fileName

isTemplate

FLAG_MSG_TYPE

FLAG_TEXT_TYPE

FLAG_HOSTFLD_TYPE

FLAG_KBDIND_TYPE

FLAG_CAPSLOCK_SUBTYPE

FLAG_NUMLOCK_SUBTYPE

FLAG_SCRLOCK_SUBTYPE

FLAG_INSERT_SUBTYPE

FLAG_DATETIME

FLAG_STIME_SUBTYPE

FLAG_LTIME_SUBTYPE

FLAG_SDATE_SUBTYPE

FLAG_LDATE_SUBTYPE

FLAG_CUSTOMDT_SUBTYPE

FLAG_STDBUTTON

FLAG_LARROW_SUBTYPE

FLAG_RARROW_SUBTYPE

FLAG_QUESTION_SUBTYPE

FLAG_BMPBUTTON

FLAG_BITMAP

FLAG_USERDRAW

FLAG_SPACING

globalFileIndex

Constructor Detail

PhantomCBar

PhantomCBar

Method Detail

load

save

save

createPhantomBar

saveRef

getRefSaveSize

getSaveSize

getCreateFlags

getFontSize

getBarControls

getHostField

getObject

getBarControl

getControlWithLabel

needsReload

reload