VirtualCBarControl (NetPhantom® 7.7 Java API Specification)

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

Direct Known Subclasses:

VirtualCBarBitmap, VirtualCBarBmpButton, VirtualCBarDateTime, VirtualCBarHostField, VirtualCBarKbdIndicator, VirtualCBarMessage, VirtualCBarSpacing, VirtualCBarStdButton, VirtualCBarText, VirtualCBarUserDraw
```
public abstract class VirtualCBarControl
extends Object
```
The Bar control class is a superclass for all bar control objects.

Author:

Åsa Persson

Field Summary

Fields
Modifier and Type	Field and Description
`protected VirtualCBar`	`bar` The bar data
`protected int`	`controlFlags`
`protected int`	`controlType`
`protected boolean`	`hasChanged` Flag indicating that this control has changed and needs to update the client
`protected String`	`label`
`protected PhantomCBarControl`	`phantomControl`
`protected int`	`state`
`static int`	`STATE_DISABLE`
`static int`	`STATE_ENABLE` Different states that can be set by the setState update method
`static int`	`STATE_HIDE`
`static int`	`STATE_SHOW`
`protected int`	`subControlType`
`protected static int`	`UPDATE_STATE_ADDCTL`
`protected static int`	`UPDATE_STATE_DELETECTL`
`protected static int`	`UPDATE_STATE_NONE` Different update states used at fireUpdate to indicate the kind of updates for the client
`protected static int`	`UPDATE_STATE_REFRESHBAR`
`protected static int`	`UPDATE_STATE_REFRESHCTL`
`protected static int`	`UPDATE_STATE_REFRESHTEXTPROMPT`
`protected static int`	`UPDATE_STATE_REPLACECTL`
`protected static int`	`UPDATE_STATE_SETSTATE`
`protected static int`	`UPDATE_STATE_SETTEXT`
`protected static int`	`UPDATE_STATE_SETTEXTEX`
`protected int`	`width`

Constructor Summary

Constructors
Constructor and Description

VirtualCBarControl(VirtualCBar bar, PhantomCBarControl phantomControl)
Constructor.

Constructors
Constructor and Description
`VirtualCBarControl(VirtualCBar bar, PhantomCBarControl phantomControl)` Constructor.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addUpdate(int op, int data)` Adds a new update item as String.
`protected void`	`addUpdate(int op, String data)` Adds a new update item as String.
`boolean`	`areTextPromptsAlwaysRefreshed()` If the class has a need to refresh the text prompt at all host changed, it must reply `true` to this method call.
`void`	`fireCreate(Transaction trans)` This method is used to fire a create message to the client by a virtual class.
`abstract void`	`fireUpdate(Transaction trans)` This method is used to fire an update message to the client by a virtual class.
`protected void`	`fireUpdate(Transaction trans, boolean doTranslate)` This method is used to fire an update message to the client by a virtual class.
`String`	`getLabel()` Returns the bar control label.
`boolean`	`hasChanged()` Checks if the base control data with possible text data has changed.
`void`	`hostScreenChanged(PhantomHostScreen screen)` The connected host screen has changed.
`void`	`issueAction()` Update from client.
`void`	`refresh()` This method is used to refresh the bar control.
`void`	`refreshTextPrompts()` This method is used to refresh all virtual controls when e.g.
`void`	`setChanged()` This method is used to indicate that a virtual class has changed and that it needs to update the client.
`boolean`	`setState(int state)` Method that is called when the REXX function SetState is called.
`boolean`	`setText(String text)` Method that is called when the REXX function SetText is called
`boolean`	`setTextEx(String text)` Method that is called when the REXX function SetTextEx is called

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

- Field Detail
  - hasChanged
```
protected boolean hasChanged
```
    Flag indicating that this control has changed and needs to update the client
  - UPDATE_STATE_NONE
```
protected static final int UPDATE_STATE_NONE
```
    Different update states used at fireUpdate to indicate the kind of updates for the client
    
    See Also:
    
    Constant Field Values
  - UPDATE_STATE_SETTEXT
```
protected static final int UPDATE_STATE_SETTEXT
```
    See Also:
    
    Constant Field Values
  - UPDATE_STATE_SETTEXTEX
```
protected static final int UPDATE_STATE_SETTEXTEX
```
    See Also:
    
    Constant Field Values
  - UPDATE_STATE_SETSTATE
```
protected static final int UPDATE_STATE_SETSTATE
```
    See Also:
    
    Constant Field Values
  - UPDATE_STATE_ADDCTL
```
protected static final int UPDATE_STATE_ADDCTL
```
    See Also:
    
    Constant Field Values
  - UPDATE_STATE_DELETECTL
```
protected static final int UPDATE_STATE_DELETECTL
```
    See Also:
    
    Constant Field Values
  - UPDATE_STATE_REPLACECTL
```
protected static final int UPDATE_STATE_REPLACECTL
```
    See Also:
    
    Constant Field Values
  - UPDATE_STATE_REFRESHBAR
```
protected static final int UPDATE_STATE_REFRESHBAR
```
    See Also:
    
    Constant Field Values
  - UPDATE_STATE_REFRESHCTL
```
protected static final int UPDATE_STATE_REFRESHCTL
```
    See Also:
    
    Constant Field Values
  - UPDATE_STATE_REFRESHTEXTPROMPT
```
protected static final int UPDATE_STATE_REFRESHTEXTPROMPT
```
    See Also:
    
    Constant Field Values
  - STATE_ENABLE
```
public static final int STATE_ENABLE
```
    Different states that can be set by the setState update method
    
    See Also:
    
    Constant Field Values
  - STATE_DISABLE
```
public static final int STATE_DISABLE
```
    See Also:
    
    Constant Field Values
  - STATE_HIDE
```
public static final int STATE_HIDE
```
    See Also:
    
    Constant Field Values
  - STATE_SHOW
```
public static final int STATE_SHOW
```
    See Also:
    
    Constant Field Values
  - state
```
protected int state
```
  - bar
```
protected VirtualCBar bar
```
    The bar data
  - phantomControl
```
protected PhantomCBarControl phantomControl
```
  - width
```
protected int width
```
  - controlType
```
protected int controlType
```
  - subControlType
```
protected int subControlType
```
  - controlFlags
```
protected int controlFlags
```
  - label
```
protected String label
```
- Constructor Detail
  - VirtualCBarControl
```
public VirtualCBarControl(VirtualCBar bar,
                          PhantomCBarControl phantomControl)
```
    Constructor.
- Method Detail
  - fireCreate
```
public void fireCreate(Transaction trans)
```
    This method is used to fire a create message to the client by a virtual class.
  - addUpdate
```
protected void addUpdate(int op,
                         String data)
```
    Adds a new update item as String.
    
    Parameters:
    
    op - The update operation.
    
    data - The update data.
  - addUpdate
```
protected void addUpdate(int op,
                         int data)
```
    Adds a new update item as String.
    
    Parameters:
    
    op - The update operation.
    
    data - The update data.
  - fireUpdate
```
public abstract void fireUpdate(Transaction trans)
```
    This method is used to fire an update message to the client by a virtual class.
  - fireUpdate
```
protected final void fireUpdate(Transaction trans,
                                boolean doTranslate)
```
    This method is used to fire an update message to the client by a virtual class.
  - refresh
```
public void refresh()
```
    This method is used to refresh the bar control.
  - refreshTextPrompts
```
public void refreshTextPrompts()
```
    This method is used to refresh all virtual controls when e.g. a new panel is created or recreated.
  - areTextPromptsAlwaysRefreshed
```
public boolean areTextPromptsAlwaysRefreshed()
```
    If the class has a need to refresh the text prompt at all host changed, it must reply true to this method call. Otherwise return false.
  - hostScreenChanged
```
public void hostScreenChanged(PhantomHostScreen screen)
```
    The connected host screen has changed. This can cause a need to change the host screen for host fields.
  - hasChanged
```
public boolean hasChanged()
```
    Checks if the base control data with possible text data has changed. If this has been changed, an update transaction is required. This transaction will occur at a later point in time, by the ClientWorker thread.
    The text change flag is not checked in this method, the control subclassing this class is responsible to call "setChanged()" whenever any child component of the virtual control has changed. This will guarantee that the entire chane of components, even upwards in the tree will synchronize the client panels and components.
  - setChanged
```
public void setChanged()
```
    This method is used to indicate that a virtual class has changed and that it needs to update the client. It is also notified to its parent, the virtual panel.
  - getLabel
```
public String getLabel()
```
    Returns the bar control label.
  - setText
```
public boolean setText(String text)
```
    Method that is called when the REXX function SetText is called
  - setTextEx
```
public boolean setTextEx(String text)
```
    Method that is called when the REXX function SetTextEx is called
  - setState
```
public boolean setState(int state)
```
    Method that is called when the REXX function SetState is called. Called by all other bar controls than the button bar controls.
  - issueAction
```
public void issueAction()
```
    Update from client. This method must be redefined in subclasses if needed.

Class VirtualCBarControl

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

hasChanged

UPDATE_STATE_NONE

UPDATE_STATE_SETTEXT

UPDATE_STATE_SETTEXTEX

UPDATE_STATE_SETSTATE

UPDATE_STATE_ADDCTL

UPDATE_STATE_DELETECTL

UPDATE_STATE_REPLACECTL

UPDATE_STATE_REFRESHBAR

UPDATE_STATE_REFRESHCTL

UPDATE_STATE_REFRESHTEXTPROMPT

STATE_ENABLE

STATE_DISABLE

STATE_HIDE

STATE_SHOW

state

bar

phantomControl

width

controlType

subControlType

controlFlags

label

Constructor Detail

VirtualCBarControl

Method Detail

fireCreate

addUpdate

addUpdate

fireUpdate

fireUpdate

refresh

refreshTextPrompts

areTextPromptsAlwaysRefreshed

hostScreenChanged

hasChanged

setChanged

getLabel

setText

setTextEx

setState

issueAction