PhantomCBar (NetPhantom® 7.7 Java API Specification)

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

All Implemented Interfaces:

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

Author:

Åsa Persson

Field Summary

Fields
Modifier and Type	Field and Description
`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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)` Checks for equality.
`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
`ENPRootObject`	`getCachedNPObject()` Gets the cached NPObject root.
`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
`String`	`getDescription()` Gets the Bar template file description.
`int`	`getFontSize()` Returns the font size
`ENPRootObject`	`getNPObject()` Gets the NPObjects for the host data.
`String`	`getNPObjectName()` Gets the NP Object file name in the project application directory.
`String`	`getTemplateFileName()` Gets the Bar Template name, i.e.
`void`	`onENPObjectInvalidated()` Invalidates the chain of objects up to the owner in order to get it sent to Eclipse.
`void`	`save(String namedFile)` Saves the bar to a named file.

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

- Field Detail
  - 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
- Method Detail
  - save
```
public void save(String namedFile)
          throws IOException
```
    Saves the bar to a named file.
    
    Parameters:
    
    namedFile -
    
    Throws:
    
    IOException
  - getDescription
```
public String getDescription()
```
    Gets the Bar template file description.
  - 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
  - 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
  - getTemplateFileName
```
public String getTemplateFileName()
```
    Gets the Bar Template name, i.e. the file name including the .PHO file extension.
    
    Returns:
    
    null If it's not a template Bar.
  - getNPObjectName
```
public String getNPObjectName()
```
    Gets the NP Object file name in the project application directory.
    
    Specified by:
    
    getNPObjectName in interface INPObjects
  - onENPObjectInvalidated
```
public void onENPObjectInvalidated()
```
    Invalidates the chain of objects up to the owner in order to get it sent to Eclipse.
    
    Specified by:
    
    onENPObjectInvalidated in interface IENPObjectOwner
  - getCachedNPObject
```
public ENPRootObject getCachedNPObject()
```
    Gets the cached NPObject root.
    
    Specified by:
    
    getCachedNPObject in interface INPObjects
    
    Returns:
    
    The cached root or null for none.
  - getNPObject
```
public ENPRootObject getNPObject()
```
    Gets the NPObjects for the host data.
    
    Specified by:
    
    getNPObject in interface INPObjects
  - equals
```
public boolean equals(Object o)
```
    Checks for equality.
    
    Overrides:
    
    equals in class Object

Class PhantomCBar

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

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

Method Detail

save

getDescription

getCreateFlags

getFontSize

getBarControls

getBarControl

getControlWithLabel

getTemplateFileName

getNPObjectName

onENPObjectInvalidated

getCachedNPObject

getNPObject

equals