java.lang.Object
- com.iizix.prop.GProp<GProp<?>[]>
- - com.iizix.prop.PropCnr
  - - com.iizix.prop.ui.MessageBox

All Implemented Interfaces:
EventListener, IClientSessionDisposeListener, IMessageBox, IGProp<GProp<?>[]>, IPropCnr, java.lang.Cloneable
```
public class MessageBox
extends PropCnr
implements IMessageBox, IClientSessionDisposeListener
```
The message box is a container to display a message box on the client side and wait for the user reply.
Author:
Christopher Mindus

Nested Class Summary
- Nested classes/interfaces inherited from interface com.iizix.gyro.IMessageBox
  IMessageBox.Icon

Field Summary
- Fields inherited from class com.iizix.prop.PropCnr
  EMPTY, EMPTY_CLASSES, EMPTY_CNRS, EXTENDS_FRAMEWORK_ERROR_ID
- Fields inherited from class com.iizix.prop.GProp
  GPDEBUG, PROP_ATTR_STRING_EDITOR_PROP, PROP_ATTR_STRING_ERRORED_NAME, PROP_ATTR_STRING_EXTENDS, PROP_ATTR_STRING_EXTENDS_FINAL, PROP_ATTR_STRING_EXTENDS_PRIVATE, PROP_ATTR_STRING_NULLABLE, PROP_ATTR_STRING_PRIVATE, PROP_ATTR_STRING_PRIVATE_CHANGE_EVENT, PROP_ATTR_STRING_READ_ONLY, PROP_USER_1, PROP_USER_2
- Fields inherited from interface com.iizix.prop.IGProp
  EQC_ERROR_IGNORE_ALL, EQC_ERROR_IGNORE_REFERENCES, EQC_IGNORE_ARRAY, EQC_IGNORE_VOLATILE_OR_EDITOR, EQC_PRIVATE, EQC_SAVE_FILE, EXT_CONTAINER_EXTENDS, EXT_CONTAINER_EXTENDS_VALID, EXT_EXTENDED, EXT_FINAL, EXT_OVERRIDES, EXT_OVERRIDES_FINAL_ERR, EXT_PRIVATE
- Fields inherited from interface com.iizix.gyro.IMessageBox
  ICON_ERROR, ICON_INFORMATION, ICON_MAP, ICON_NONE, ICON_QUESTION, ICON_WARNING

Constructor Summary
Constructors
Constructor Description
MessageBox()
Creates the container without name with a null value without name.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`addReplyListener(IMessageBoxReply listener)`	Adds a listener for the callback when user chooses an action for the message box.
`void`	`cancel()`	Called to remove the message box without further processing for user or notifications.
`MessageBox`	`clone()`	Clones the message box.
`MessageBox`	`cloneWithListeners()`	Clones the message box and keeps all the listeners.
`MessageBox`	`getAppSessionMessageBox()`	Gets the original AppSession instance of the message box when used in a client session.
`KString`	`getMessage()`	Gets the message text of the message box.
`java.lang.String`	`getMessagePlainString()`	Gets the message text of the message box.
`KString`	`getTitle()`	Gets the title of the message box.
`java.lang.String`	`getTitlePlainString()`	Gets the title of the message box.
`void`	`messageBox(IMessageBoxReply reply, IMessageBox.Icon icon, KString title, KString message, KString... buttons)`	Displays a message box with the specified title and message.
`void`	`onDispose(IClientSessionGyro clientGyro)`	Called when the client session is disposed of.
`void`	`onRemoteEvent(RemoteEvent event)`	Called when a remote property event should be processed by this property.
`boolean`	`removeReplyListener(IMessageBoxReply listener)`	Removes a listener for the callback when user chooses an action for the message box.
`protected boolean`	`shouldSerializeToXML(int programType)`	Method used to check for serialization to XML.
`void`	`show()`	Called to display the message box on the client.

Methods inherited from class com.iizix.prop.PropCnr
__transferChildProps, addPredefinedProps, addProp, addProp, addProp2, addProp2, appendPropValue, canRequestFocus, completeVirtualize, containsProp, containsProp, convertLoadedProp, couldRequestFocusIfVirtualized, createCopyOfAtom, createUniqueAtom, createUniqueAtom, createUniqueAtom, createVSReference, doPropEqualsArrayValues, doVirtualizePropCnr, enablePropCommunication, enablePropHashMap, equalsTree, equalsTree, getAllProps, getAllProps, getAllProps, getAllProps, getAllProps, getAllProps, getAllProps, getAllProps, getBool, getBool, getBool, getBool, getChildPropError, getChildPropError, getChildPropErrorSeverity, getChildPropErrorSeverity, getErrorsProp, getExtendsContainer, getExtendsError, getExtendsName, getExtendsOverride, getExtendsPossibleClasses, getFirstProp, getFirstProp, getFocusEngine, getInt, getInt, getInt, getInt, getLong, getLong, getLong, getLong, getNumber, getNumber, getNumber, getNumber, getPossibleChildren, getPredefinedProps, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getPropBaseReference, getPropCnr, getPropCount, getPropCount, getPropIndex, getPropIndex, getPropIndexes, getProps, getProps, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue0, getReferences, getRetargetedVerifyContainer, getString, getString, getString, getString, getValueClasses, getVSReference, hasFocus, hasSendData, initializeElement, initializeExtendsFramework, initializeProp, initializeValue, initPropCnr, insertProp, insertProp2, isChild, isExtendsOverriden, isExtendsPropertyValid, isExtendsRoot, isPropAddRemoveAllowed, isPropCommunicating, isPropExtended, isSibling, list, list, logPropNotFound, maybeAddProp, onInsertProp, onPropDispose, onPropRemoved, onPropTreeInitialized, onReferenceEvent, paramString, prepare, removeAllProps, removeAllProps2, removeProp, removeProp, removeProp, removeProp, removeProp, removeProp, removeProp, removeProp2, removeProp2, removeProp2, removeProp2, removeProp2, removeProp2, removeProp2, reorderProps, replaceProps, requestFocus, requestFocus, requestFocusEx, requestFocusEx, resolveReferences, resolveRuntimeReferences, setBool, setBool, setBool, setBool, setCreateRequiredProp, setExtendsName, setExtendsOverride, setInt, setInt, setInt, setLong, setLong, setLong, setLong, setNumber, setNumber, setNumber, setNumber, setProp, setProp, setProp, setProp2, setProp2, setPropValue, setPropValue, setPropValue, setPropValue, setPropValue, setPropValue, setString, setString, setString, setString, shouldCreateProps, shouldSerializeToXML, toElementString, toNativeValue0, usePropHashMap, usesPropIndex, validateChildPropInValue, validateClassInstances, validatePropType, validatePropValue, verify, verifyInternalUseOnly, verifyTree, virtualize

Methods inherited from class com.iizix.prop.GProp
addPropError, addPropListener, convertPropError, dispose, equals, equals, equalsErrors, equalsObj, equalsPropValue, equalValues, extendsClone, finalize, fine, fine, finer, finer, finest, finest, fromElementString, getAliasName, getAppSessionGyro, getAppWorker, getAtomPath, getAttribute, getChildReferencePropName, getClientSessionGyro, getClientWorker, getConstraints, getEnvironment, getErroredPropItems, getErroredProps, getErrorsProp, getExtendsRootContainer, getFullPropName, getFullPropName, getFullPropNameDebug, getFullPropNameDebug, getListeners, getModuleFolder, getModuleFolder, getParent, getParent, getProjectName, getPropAtom, getPropError, getPropError, getPropErroredName, getPropErrorSeverity, getPropExtendsFlags, getPropFromPath, getPropFromPath, getPropFromReference, getPropFromReference, getPropIndex, getPropName, getPropPath, getPropPath, getPropReferenceTarget, getPropRootPropMgr, getPropTreeErrorSeverity, getPropValue, getPropValue, getPropValueObject, getReferencePropName, getRelativePropName, getRootFromName, getRootName, getRootParent, getRootParent, getTreeLock, hasChanged, hasPrivateChangeEventProp, hasPropError, hasPropTreeError, info, info, initializeGElement, initializeGProp, isDisposed, isPropChildOf, isPropClientCreated, isPropCreateRequired, isPropExtended, isPropExtendsFinal, isPropExtendsPrivate, isPropExtendsPrivateInRoot, isPropExtendsPrivateInRoot, isPropFile, isPropFolder, isPropForEditor, isPropNullable, isPropPrivate, isPropPrivateAtCreation, isPropReadOnly, isPropReferenceTreeValid, isPropRoot, isPropUSER, isPropValueTreeLockNeeded, isPropVirtualized, isPropVirtualizing, isPropVolatile, isPropVolatileOrEditorOnly, isProxied, list, list, list, mapAliasToReference, mapAliasToReference, mapReferenceToAlias, mapReferenceToAlias, mapReferenceToProjectRelative, modifyPropValue, moveProp, moveProp, moveProp, onEvent, onEventSelf, onPrepare, onPropInvalidateCache, onPropParentChanged, onPropValueSet, onVirtualizationCompleted, onVirtualized, paramValue, post, post, removePropError, removePropListener, removePropUSER, renameProp, renameProp2, resetChangedTree, setChanged, setConstraints, setConstraints, setParent, setPrivateChangeEventProp, setPrivateCreateRequiredProp, setPropError, setPropErroredName, setPropExtended, setPropExtendsFinal, setPropExtendsPrivate, setPropForEditor, setPropNullable, setPropPrivate, setPropReadOnly, setPropUSER, setPropValue, setPropValue, setPropValue, setPropValueIncognito, setPropVolatile, severe, severe, severe, throwIfReadOnly, toNativeValue, toString, toString, triggerRemoteEvent, triggerRemoteEvent, validateProp, verifyHasPropertyItem, warning, warning, warning

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

Methods inherited from interface com.iizix.prop.IGProp
addPropError, addPropListener, dispose, equals, fine, fine, finer, finer, finest, finest, fromElementString, getAppSessionGyro, getAtomPath, getClientSessionGyro, getConstraints, getEnvironment, getErroredPropItems, getErroredProps, getErrorsProp, getExtendsRootContainer, getFullPropName, getFullPropNameDebug, getModuleFolder, getModuleFolder, getParent, getParent, getPropAtom, getPropError, getPropError, getPropErrorSeverity, getPropExtendsFlags, getPropFromPath, getPropFromReference, getPropIndex, getPropName, getPropPath, getPropPath, getPropRootPropMgr, getPropTreeErrorSeverity, getPropValue, getPropValue, getReferencePropName, getRelativePropName, getRootParent, getTreeLock, hasChanged, hasPrivateChangeEventProp, hasPropError, hasPropTreeError, info, info, initializeGElement, initializeGProp, isDisposed, isPropChildOf, isPropClientCreated, isPropCreateRequired, isPropExtended, isPropExtendsFinal, isPropExtendsPrivate, isPropExtendsPrivateInRoot, isPropExtendsPrivateInRoot, isPropFile, isPropFolder, isPropNullable, isPropPrivate, isPropReadOnly, isPropReferenceTreeValid, isPropRoot, isPropVirtualized, list, list, list, mapAliasToReference, mapReferenceToAlias, mapReferenceToProjectRelative, moveProp, moveProp, moveProp, onEvent, onEventSelf, removePropError, removePropListener, renameProp, setChanged, setConstraints, setConstraints, setParent, setPrivateChangeEventProp, setPropError, setPropExtendsFinal, setPropExtendsPrivate, setPropNullable, setPropPrivate, setPropReadOnly, setPropValue, setPropValue, severe, severe, severe, toNativeValue, triggerRemoteEvent, triggerRemoteEvent, validateProp, verifyHasPropertyItem, warning, warning, warning

Methods inherited from interface com.iizix.gyro.IMessageBox
messageBox, messageBox

Methods inherited from interface com.iizix.prop.IPropCnr
canRequestFocus, canRequestFocus, couldRequestFocusIfVirtualized, couldRequestFocusIfVirtualized

- Constructor Detail
  - MessageBox
```
public MessageBox()
```
    Creates the container without name with a null value without name.
- Method Detail
  - shouldSerializeToXML
```
protected boolean shouldSerializeToXML(int programType)
```
    Method used to check for serialization to XML.
    Overrides:
    shouldSerializeToXML in class GProp<GProp<?>[]>
    Parameters:
    programType - From PropFactory.getProgramType(): 0=PropFactory.CLIENT, 1=PropFactory.SERVER or 2=PropFactory.EDITOR.
    Returns:
    false, never to XML!
  - getAppSessionMessageBox
```
public MessageBox getAppSessionMessageBox()
```
    Gets the original AppSession instance of the message box when used in a client session.
    Returns:
    The message box, null if not from AppSession.
  - clone
```
public MessageBox clone()
```
    Clones the message box. The new instance has no listeners.
    Overrides:
    clone in class PropCnr
    Returns:
    A new instance of the message box.
  - cloneWithListeners
```
public MessageBox cloneWithListeners()
```
    Clones the message box and keeps all the listeners.
    Returns:
    A new instance of the message box with all the listeners.
  - onDispose
```
public void onDispose(IClientSessionGyro clientGyro)
```
    Called when the client session is disposed of. This will inform pending message boxes about session closure.
    Specified by:
    onDispose in interface IClientSessionDisposeListener
    Parameters:
    clientGyro - The client session gyro.
  - addReplyListener
```
public boolean addReplyListener(IMessageBoxReply listener)
```
    Adds a listener for the callback when user chooses an action for the message box.
    Parameters:
    listener - The listener.
    Returns:
    true if added, false if already added.
  - removeReplyListener
```
public boolean removeReplyListener(IMessageBoxReply listener)
```
    Removes a listener for the callback when user chooses an action for the message box.
    Parameters:
    listener - The listener.
    Returns:
    true if removed, false if not previously added.
  - messageBox
```
public void messageBox(IMessageBoxReply reply,
                       IMessageBox.Icon icon,
                       KString title,
                       KString message,
                       KString... buttons)
```
    Displays a message box with the specified title and message. The icon can be specified as Informational, Question, Error or None. The buttons can be specified along with the default button (when the Enter key is pressed for keyboard/desktop systems).
    Specified by:
    messageBox in interface IMessageBox
    Parameters:
    reply - The reply callback that is called when the user chooses a button or session is closed, null for none.
    icon - Icon to display, see the ICON_* values, e.g. IMessageBox.ICON_INFORMATION.
    title - The title string, must be non-null.
    message - The message to display, must be non-null.
    buttons - The strings for the buttons to display, if none, just an OK button is displayed. This array of buttons defined the index value returned by this method.
    Throws:
    java.lang.NullPointerException - If icon or message is null, or if any of the elements in buttons array is null.
  - getTitle
```
public KString getTitle()
```
    Gets the title of the message box.
    Returns:
    The title, or null for none.
  - getTitlePlainString
```
public java.lang.String getTitlePlainString()
```
    Gets the title of the message box.
    Returns:
    The title plain string converted from HTML, or null for none.
  - getMessage
```
public KString getMessage()
```
    Gets the message text of the message box.
    Returns:
    The message text, or null for none.
  - getMessagePlainString
```
public java.lang.String getMessagePlainString()
```
    Gets the message text of the message box.
    Returns:
    The message text plain string converted from HTML, or null for none.
  - show
```
public void show()
```
    Called to display the message box on the client.
  - onRemoteEvent
```
public void onRemoteEvent(RemoteEvent event)
```
    Called when a remote property event should be processed by this property.
    Specified by:
    onRemoteEvent in interface IGProp<GProp<?>[]>
    Overrides:
    onRemoteEvent in class GProp<GProp<?>[]>
    Parameters:
    event - The remote event.
  - cancel
```
public void cancel()
```
    Called to remove the message box without further processing for user or notifications.

Class MessageBox

Nested Class Summary

Nested classes/interfaces inherited from interface com.iizix.gyro.IMessageBox

Field Summary

Fields inherited from class com.iizix.prop.PropCnr

Fields inherited from class com.iizix.prop.GProp

Fields inherited from interface com.iizix.prop.IGProp

Fields inherited from interface com.iizix.gyro.IMessageBox

Constructor Summary

Method Summary

Methods inherited from class com.iizix.prop.PropCnr

Methods inherited from class com.iizix.prop.GProp

Methods inherited from class java.lang.Object

Methods inherited from interface com.iizix.prop.IGProp

Methods inherited from interface com.iizix.gyro.IMessageBox

Methods inherited from interface com.iizix.prop.IPropCnr

Constructor Detail

MessageBox

Method Detail

shouldSerializeToXML

getAppSessionMessageBox

clone

cloneWithListeners

onDispose

addReplyListener

removeReplyListener

messageBox

getTitle

getTitlePlainString

getMessage

getMessagePlainString

show

onRemoteEvent

cancel