VirtualHostField (NetPhantom® 7.7 Java API Specification)

java.lang.Object
- se.entra.phantom.server.VirtualTextData
- - se.entra.phantom.server.VirtualHostField

Direct Known Subclasses:

VirtualOutputHostField
```
public class VirtualHostField
extends VirtualTextData
```
Handles text prompt data for multiple purposes using transactions and changes. Typically a static text control (the virtual one) uses this class. The class is extended from VirtualTextData that provides the text support.

Field Summary

Fields
Modifier and Type	Field and Description
`boolean`	`isFound` The real host field found flag.
`boolean`	`isHidden` The hidden flag.
`boolean`	`isProtected` The protected flag.
`VirtualSessionManager`	`manager` The virtual session manager.
`static String`	`PROPERTY_DYNAMIC_HOST_FIELD` Property string for using a dynamic host field position and length.
`static String`	`PROPERTY_DYNAMIC_HOST_FIELD_NOWRAP` Property string to set the dynamic host field position and length not to wrap line on the host screen.
`int`	`vioColor` The VIO color of the field.

Constructor Summary

Constructors
Constructor and Description
`VirtualHostField(VirtualControl control, PhantomHostField hostField)` The constructor saves the host field and references to the host session.
`VirtualHostField(VirtualControl control, PhantomHostField hostField, String hostFieldName)` The constructor saves the host field and references to the host session.
`VirtualHostField(VirtualPanel panel, PhantomHostField hostField)` The constructor saves the host field and references to the host session.
`VirtualHostField(VirtualPanel panel, PhantomHostField hostField, String hostFieldName)` The constructor saves the host field and references to the host session.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`format()` Formats this string and possibly changes the text contents.
`boolean`	`format(boolean attributesOnly)` Formats this string and possibly changes the text contents.
`Object`	`getProperty(String propertyName)` Gets a property of this host field.
`int`	`getRealHostFieldLength()` Returns the length of the connected host field.
`boolean`	`hasRealHostField()` Checks if there is a real host field in the virtual host field.
`void`	`hostScreenChanged(PhantomHostScreen screen, PhantomHostField hostField, String hostFieldName)` The connected host screen has changed.
`boolean`	`isDynamic()` Checks if the host field is dynamic or not.
`boolean`	`isHostFieldCurrentlyProtected()` Checks if the connected host field is protected or not.
`boolean`	`isHostFieldPresent()` Checks if the host field is currently present on this screen or not.
`void`	`setCursor()` Sets the host cursor to this hostfield.
`void`	`setDynamic(boolean on)` Sets this host field to be dynamic or not.
`boolean`	`setProperty(String propertyName, Object property)` Sets a property of this host field.
`boolean`	`setText(String t)` Sets the text of an item.
`boolean`	`update(String text)` Use this method to update the text prompt and host field with any new text contents.
`boolean`	`update(String text, boolean alwaysUpdateHost)` Use this method to update the text prompt and host field with any new text contents.
`boolean`	`update(Transaction trans)` Use this method to update the text and host field with any new text contents of an inbound transaction from the client.

Methods inherited from class se.entra.phantom.server.VirtualTextData
appendTransaction, appendUpdateTransaction, getLength, getText, getTextResetChange, hasChanged, resetChange, setChanged, setText

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

- Field Detail
  - PROPERTY_DYNAMIC_HOST_FIELD
```
public static final String PROPERTY_DYNAMIC_HOST_FIELD
```
    Property string for using a dynamic host field position and length.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_DYNAMIC_HOST_FIELD_NOWRAP
```
public static final String PROPERTY_DYNAMIC_HOST_FIELD_NOWRAP
```
    Property string to set the dynamic host field position and length not to wrap line on the host screen.
    This property is used in conjuction with the property PROPERTY_DYNAMIC_HOST_FIELD and typically with protected host fields.
    
    See Also:
    
    Constant Field Values
  - manager
```
public VirtualSessionManager manager
```
    The virtual session manager.
  - isProtected
```
public boolean isProtected
```
    The protected flag.
  - isHidden
```
public boolean isHidden
```
    The hidden flag.
  - isFound
```
public boolean isFound
```
    The real host field found flag. This flag is false if the host field cannot be located on the screen. In this case, isHidden=isProtected=true.
  - vioColor
```
public int vioColor
```
    The VIO color of the field.
- Constructor Detail
  - VirtualHostField
```
public VirtualHostField(VirtualControl control,
                        PhantomHostField hostField)
```
    The constructor saves the host field and references to the host session. The "format" method is then used to format the text itself from the host field. The "hostField" parameter may be null, indicating that there is no host field at all.
  - VirtualHostField
```
public VirtualHostField(VirtualControl control,
                        PhantomHostField hostField,
                        String hostFieldName)
```
    The constructor saves the host field and references to the host session. The "format" method is then used to format the text itself from the host field. The "hostField" parameter may be null, indicating that there is no host field at all.
    The hostField may be null, in which case the current host screen is searched to find the matching hostFieldName. If hostFieldName is null, no search will be performed.
  - VirtualHostField
```
public VirtualHostField(VirtualPanel panel,
                        PhantomHostField hostField)
```
    The constructor saves the host field and references to the host session. The "format" method is then used to format the text itself from the host field. The "hostField" parameter may be null, indicating that there is no host field at all.
  - VirtualHostField
```
public VirtualHostField(VirtualPanel panel,
                        PhantomHostField hostField,
                        String hostFieldName)
```
    The constructor saves the host field and references to the host session. The "format" method is then used to format the text itself from the host field. The "hostField" parameter may be null, indicating that there is no host field at all.
    The hostField may be null, in which case the current host screen is searched to find the matching hostFieldName. If hostFieldName is null, no search will be performed.
- Method Detail
  - hostScreenChanged
```
public void hostScreenChanged(PhantomHostScreen screen,
                              PhantomHostField hostField,
                              String hostFieldName)
```
    The connected host screen has changed. This can cause a need to change the host screen for host fields.
  - hasRealHostField
```
public boolean hasRealHostField()
```
    Checks if there is a real host field in the virtual host field.
  - isHostFieldPresent
```
public boolean isHostFieldPresent()
```
    Checks if the host field is currently present on this screen or not.
  - getRealHostFieldLength
```
public int getRealHostFieldLength()
```
    Returns the length of the connected host field.
    
    Returns:
    
    0 if no real host field is connected.
  - format
```
public boolean format()
```
    Formats this string and possibly changes the text contents. The isRefreshRequired flag should be true if the text must always be checked for a change.
    
    Returns:
    
    true if the text and/or attributes changed with this call, false otherwise.
  - format
```
public boolean format(boolean attributesOnly)
```
    Formats this string and possibly changes the text contents. The isRefreshRequired flag should be true if the text must always be checked for a change.
    
    Returns:
    
    true if the text and/or attributes changed with this call, false otherwise. The text is not checked if the flag "attributesOnly" is true.
  - isHostFieldCurrentlyProtected
```
public boolean isHostFieldCurrentlyProtected()
```
    Checks if the connected host field is protected or not.
  - update
```
public boolean update(Transaction trans)
```
    Use this method to update the text and host field with any new text contents of an inbound transaction from the client. Upon failure, an event is logged.
    
    Returns:
    
    true = success, the host field is updated (or no host field is specified), false = failure, host field update failed (e.g. abort current update transaction).
  - update
```
public boolean update(String text)
```
    Use this method to update the text prompt and host field with any new text contents. Upon failure, an event is logged.
    
    Returns:
    
    true = success, the host field is updated (or no host field is specified), false = failure, host field update failed (e.g. abort current update transaction).
  - update
```
public boolean update(String text,
                      boolean alwaysUpdateHost)
```
    Use this method to update the text prompt and host field with any new text contents. Upon failure, an event is logged. The "alwaysUpdateHost" flag indicates if the update should be done even if the host field is protected.
    
    Returns:
    
    true = success, the host field is updated (or no host field is specified), false = failure, host field update failed (e.g. abort current update transaction).
  - setText
```
public boolean setText(String t)
```
    Sets the text of an item. The change flag is affected depending of the new content.
    
    Overrides:
    
    setText in class VirtualTextData
    
    Returns:
    
    true if the text changed with this call, false otherwise.
  - setCursor
```
public void setCursor()
```
    Sets the host cursor to this hostfield.
  - setProperty
```
public boolean setProperty(String propertyName,
                           Object property)
```
    Sets a property of this host field. Valid properties are only PROPERTY_DYNAMIC_HOST_FIELD and PROPERTY_DYNAMIC_HOST_FIELD_NOWRAP.
    
    Returns:
    
    true for successful operation.
    false for failure.
  - getProperty
```
public Object getProperty(String propertyName)
```
    Gets a property of this host field. Valid properties are only PROPERTY_DYNAMIC_HOST_FIELD and PROPERTY_DYNAMIC_HOST_FIELD_NOWRAP.
    
    Returns:
    
    Object The object containing the property (a Boolean instance).
    null for failure.
  - setDynamic
```
public void setDynamic(boolean on)
```
    Sets this host field to be dynamic or not. Once this state is changed, it is the callers responsibility to force a call to "format" to update the data.
  - isDynamic
```
public boolean isDynamic()
```
    Checks if the host field is dynamic or not.

Class VirtualHostField

Field Summary

Constructor Summary

Method Summary

Methods inherited from class se.entra.phantom.server.VirtualTextData

Methods inherited from class java.lang.Object

Field Detail

PROPERTY_DYNAMIC_HOST_FIELD

PROPERTY_DYNAMIC_HOST_FIELD_NOWRAP

manager

isProtected

isHidden

isFound

vioColor

Constructor Detail

VirtualHostField

VirtualHostField

VirtualHostField

VirtualHostField

Method Detail

hostScreenChanged

hasRealHostField

isHostFieldPresent

getRealHostFieldLength

format

format

isHostFieldCurrentlyProtected

update

update

update

setText

setCursor

setProperty

getProperty

setDynamic

isDynamic