se.entra.phantom.server

Class VirtualTextData

java.lang.Object

se.entra.phantom.server.VirtualTextData

Direct Known Subclasses:

VirtualHostField, VirtualTextPrompt

public class VirtualTextData
extends Object

Handles text data for multiple purposes using transactions and changes. Typically a static text control (the virtual one) uses this class. The VirtualHostField is extended from VirtualTextData and handles updates from host. The VirtualTextPrompt is also extended from this class.

Constructor Summary

Constructors

Constructor and Description
VirtualTextData()

Method Summary

Modifier and Type	Method and Description
void	appendTransaction(Transaction trans) Always appends the text in a (create) transaction.
void	appendUpdateTransaction(Transaction trans) Appends the text in an update transaction.
int	getLength() Get the text length.
String	getText() Gets the text of an item.
String	getTextResetChange() Gets the text of the item and clears the changed flag.
boolean	hasChanged() Checks if the text has changed.
void	resetChange() Gets the text of the item and clears the changed flag.
void	setChanged() Set the text has changed.
boolean	setText(String t) Sets the text of an item.
boolean	setText(String t, boolean changeCheck) Sets the text of an item.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VirtualTextData

public VirtualTextData()

Method Detail

setText

public boolean setText(String t,
                       boolean changeCheck)

Sets the text of an item. The parameter "changeCheck" is used to perform a check for changes. If this flag is false, the change flag is left unchanged.

Returns:

true if the text changed with this call, false otherwise.

setText

public boolean setText(String t)

Sets the text of an item. The change flag is affected depending of the new content.

Returns:

true if the text changed with this call, false otherwise.

getText

public String getText()

Gets the text of an item.

Returns:

empty string if the text is null or never set, otherwise the text.

getTextResetChange

public String getTextResetChange()

Gets the text of the item and clears the changed flag.

resetChange

public void resetChange()

Gets the text of the item and clears the changed flag.

setChanged

public void setChanged()

Set the text has changed. (Force client update).

hasChanged

public boolean hasChanged()

Checks if the text has changed.

getLength

public int getLength()

Get the text length.

Returns:

zero if the text is null or never set, otherwise the length.

appendTransaction

public void appendTransaction(Transaction trans)

Always appends the text in a (create) transaction. This is done regardless if the text changed or not. The change flag is cleared.

appendUpdateTransaction

public void appendUpdateTransaction(Transaction trans)

Appends the text in an update transaction. The change flag is cleared. The format is:

  + BYTE     changed   (true = text follows, false = no text follows).
  + STRING   textData  (if "changed" is true).