se.entra.phantom.server

Interface VirtualClientMessages

All Known Implementing Classes:

VirtualCBusGraph, VirtualCCheckBox, VirtualCComboBox, VirtualCEntryField, VirtualCGroupBox, VirtualCListBox, VirtualCListCapableControl, VirtualCMLE, VirtualCNoteBook, VirtualControl, VirtualCOutputText, VirtualCPushButton, VirtualCRadioButton, VirtualCRectangle, VirtualCSpinButton, VirtualCStaticText, VirtualCSubWindow, VirtualCTree, VirtualCUnknown, VirtualCUserWindow, VirtualMenuItem, VirtualPopupMenuItem

public interface VirtualClientMessages

This interface is implemented by the all virtual classes that requires updates to be sent to the client.

Method Summary

Modifier and Type	Method and Description
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.
void	fireUpdate(Transaction trans) This method is used to fire an update message to the client by a virtual class.
void	refresh() This method is used to refresh all virtual classes when e.g.
void	refreshTextPrompts() This method is used to refresh all virtual classes that have text prompt data in them.
void	textFileChanged() The application text file has been changed, resulting in the need to reformat text strings (such as text prompts or send strings from a text ID) in order to reflect the new text file content.

Method Detail

refresh

void refresh()

This method is used to refresh all virtual classes when e.g. a new panel is created, recreated or when any host change occurs.

refreshTextPrompts

void refreshTextPrompts()

This method is used to refresh all virtual classes that have text prompt data in them. The parameter mustRefresh is set when the panel is created or recreated. If the class has a need to refresh the text prompt at all host changed, it must reply true to the method call areTextPromptsAlwaysRefreshed.

areTextPromptsAlwaysRefreshed

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.

fireCreate

void fireCreate(Transaction trans)
         throws IOException

This method is used to fire a create message to the client by a virtual class.

Throws:

IOException - if an I/O error occurs.

fireUpdate

void fireUpdate(Transaction trans)
         throws IOException

This method is used to fire an update message to the client by a virtual class.

Prior to calling this method, the parent component or class should use the method hasChanged() in order to call this method only when required.

Throws:

IOException - if an I/O error occurs.

textFileChanged

void textFileChanged()

The application text file has been changed, resulting in the need to reformat text strings (such as text prompts or send strings from a text ID) in order to reflect the new text file content.