rs.sol.soloist.server.guiconfiguration.components
Class GUIDialogComponent

java.lang.Object
  rs.sol.soloist.server.uml.commonimplementation.runtime._ClassifierInstance
      rs.sol.soloist.server.uml.commonimplementation.runtime._ClassInstance
          rs.sol.soloist.server.javaimpl.runtime.SOLoistClassInstance
              rs.sol.soloist.server.builtindomains.common.ObjectOfClass
                  rs.sol.soloist.server.guiconfiguration.construction.GUIComponent
                      rs.sol.soloist.server.guiconfiguration.components.GUIContainerComponent
                          rs.sol.soloist.server.guiconfiguration.components.GUIDialogComponent

All Implemented Interfaces:

IElementPresentationProvider, IUpdatable, rs.sol.soloist.server.uml.concepts.IElement, IClassifierInstance, IClassInstance, IRTElement

public class GUIDialogComponent
extends GUIContainerComponent

A draggable popup panel (container) with a caption. This widget must be assigned to an appropriate application widget (methods create(GUIApplicationComponent, String) and addDialog(GUIDialogComponent)). It strictly has a single child widget, which is typically a panel (class GUIContainerComponent) to which all other widgets must be added.

The code sample that creates this widget, assignes it to the application, specifies the caption, and creates its child panel is shown bellow:

 GUIDialogComponent dialog = GUIDialogComponent.create(app, "My Caption");
 GUIPanelComponent rootPanel = GUIPanelComponent.createFlow(dialog);
 rootPanel.add(...);
 rootPanel.add(...);
 
 

Author:

SOL Expert Group

Nested Class Summary

static class	GUIDialogComponent.FQPropertyNames Deprecated. Not for public use.
static class	GUIDialogComponent.PROPERTIES Deprecated. Not for public use.

Field Summary

IAssociationEndInstance<GUIApplicationComponent>	application Deprecated. Not for public use.
IAttributeValue<Boolean>	autoHide Deprecated. Not for public use.
IAttributeValue<Text>	caption Deprecated. Not for public use.
static IClass	CLASSIFIER UML class reference
static java.lang.String	FQ_TYPE_NAME Fully qualified UML class name
IAttributeValue<Text>	hide Deprecated. Not for public use.
IAttributeValue<Boolean>	modal Deprecated. Not for public use.
IAttributeValue<Boolean>	singleton Deprecated. Not for public use.

Fields inherited from class rs.sol.soloist.server.guiconfiguration.components.GUIContainerComponent

back, children, forward, input, logger, next, output, previous, refresh, reset, submit, visibleChild

Fields inherited from class rs.sol.soloist.server.guiconfiguration.construction.GUIComponent

addStyle, context, description, enabled, init, inputBindings, layoutData, name, outputBindings, ownerTable, parent, removeStyle, show, showInParent, styleName, tooltip, visible

Constructor Summary

GUIDialogComponent()

Method Summary

void	constructor() The domain-specific constructor of the Classifier.
static GUIDialogComponent	create(GUIApplicationComponent app, java.lang.String caption) Returns new GUIDialogComponent with the given caption and assigns it to the given owner application.
static GUIDialogComponent	create(GUIApplicationComponent app, java.lang.String caption, boolean modal) Returns new GUIDialogComponent with the given caption and modality and assigns it to the given owner application.
rs.sol.soloist.client.common.info.DialogInfo	createSpecificInfo() Creates and returns an empty serializable object of the appropriate ComponentInfo sub-class.
boolean	getAutoHide() Returns whether the dialog should be automatically hidden when the user clicks outside of it.
java.lang.String	getCaption() Returns the caption of this dialog.
boolean	getModal() Returns whether this dialog is modal or not.
GUIComponent	getOwner() Deprecated. Not for public use.
boolean	getSingleton() Deprecated. Not for public use.
ISlot<?>	ipCaption() Returns the caption input pin; when event occurs, the textual content of the binding message will be used as the new caption of this dialog.
ISlot<?>	ipHide() Returns the hide input pin; when event occurs, this dialog will get hidden.
boolean	isAutoHide() Deprecated. Not for public use.
boolean	isModal() Deprecated. Not for public use.
boolean	isSingleton() Deprecated. Not for public use.
void	setAutoHide(boolean autoHide) Sets whether the dialog should be automatically hidden when the user clicks outside of it.
void	setCaption(java.lang.String caption) Sets the caption of this dialog.
void	setModal(boolean modal) Sets whether this dialog is modal or not.
void	setSingleton(boolean value) Deprecated. Not for public use.
void	validate() Validates a configuration settings of this widget.

Methods inherited from class rs.sol.soloist.server.guiconfiguration.components.GUIContainerComponent

add, addFirst, clear, get, getVisibleChild, ipBack, ipForward, ipNext, ipPrevious, ipRefresh, ipRelay1, ipRelay2, ipReset, ipSubmit, ipVisibleChild, opRelay1, opRelay2, opVisibleChild, remove, removeFirst, setVisibleChild, validateSingleChild

Methods inherited from class rs.sol.soloist.server.guiconfiguration.construction.GUIComponent

addStyleNames, addValueToSlot, clearSlot, clone, createInfo, createInfoAlreadyValidated, destructor, fillElementInfo, getApplication, getCommands, getCommands, getCommonOwner, getContext, getDescription, getDescrString, getDragIcon, getEnabled, getFeature, getFeature, getInputBindings, getInputPin, getInputPins, getLabelString, getLargeIcon, getLayoutData, getName, getNameString, getOutputPin, getOutputPins, getParts, getSetting, getSmallIcon, getStyle, getSubnodes, getTooltip, getTooltipString, getTypeString, getVisible, handle, ipAddStyle, ipEnabled, ipInit, ipRemoveStyle, ipShow, ipShowInParent, ipVisible, isInputPin, isOutputPin, putFeatureInfo, readElement, readElements, readSlot, readSlotAsInfo, readSubnodes, removeValueFromSlot, setCellAlignment, setCellSize, setCellStyle, setCenter, setContext, setDescription, setDirectionAndSize, setEnabled, setLayoutData, setLeftRightWidth, setName, setRowColumn, setRowColumn, setSize, setSlot, setSlot, setStyle, setTooltip, setTopBottomHeight, setVisible, setXY, toTranslateDescriptors, translatePinName, updateInfo, validateParts, validateParts

Methods inherited from class rs.sol.soloist.server.javaimpl.runtime.SOLoistClassInstance

destroy, equals, getAssociationEndInstance, getAssociationEndInstances, getAttributeValue, getAttributeValues, getMyClass, getMyID, getSlot, getSlot, getSlots, getUMLClass, hashCode, isMarkedAsDeleted, toString

Methods inherited from class rs.sol.soloist.server.uml.commonimplementation.runtime._ClassInstance

accept, accept, exists, getAssociationEndInstance, getAssociationEndInstance, getAssociationEndInstance, getClassifier, hasIdentity, isClassInstance, isDataTypeInstance, isEqualTo, makeClone, markAsDeleted

Methods inherited from class rs.sol.soloist.server.uml.commonimplementation.runtime._ClassifierInstance

conformsTo, copySlots, copySlots, getAttributeValue, getAttributeValue, getAttributeValue, getClassifierFQName, getClassifierUQName, getFirstCommonGeneralizer, getFirstCommonGeneralizerFQName, getFirstCommonGeneralizerUQName, getMElement, getSlot, getSlot, isDirectInstanceOf, isDirectInstanceOf, isInstanceOf, isInstanceOf, isKindOf, isModelElement, isRTElement

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface rs.sol.soloist.server.uml.concepts.runtime.IClassifierInstance

conformsTo, copySlots, copySlots, getAttributeValue, getAttributeValue, getClassifierFQName, getClassifierUQName, getFirstCommonGeneralizer, getFirstCommonGeneralizerFQName, getFirstCommonGeneralizerUQName, getSlot, getSlot, isDirectInstanceOf, isDirectInstanceOf, isInstanceOf, isInstanceOf

Methods inherited from interface rs.sol.soloist.server.uml.concepts.runtime.IRTElement

getMElement

Methods inherited from interface rs.sol.soloist.server.uml.concepts.IElement

isKindOf, isModelElement, isRTElement

Field Detail

caption

@Deprecated
public IAttributeValue<Text> caption

Deprecated. Not for public use.

modal

@Deprecated
public IAttributeValue<Boolean> modal

Deprecated. Not for public use.

autoHide

@Deprecated
public IAttributeValue<Boolean> autoHide

Deprecated. Not for public use.

singleton

@Deprecated
public IAttributeValue<Boolean> singleton

Deprecated. Not for public use.

hide

@Deprecated
public IAttributeValue<Text> hide

Deprecated. Not for public use.

FQ_TYPE_NAME

public static final java.lang.String FQ_TYPE_NAME

Fully qualified UML class name

See Also:

Constant Field Values

CLASSIFIER

public static final IClass CLASSIFIER

UML class reference

application

@Deprecated
public IAssociationEndInstance<GUIApplicationComponent> application

Deprecated. Not for public use.

Constructor Detail

GUIDialogComponent

public GUIDialogComponent()

Method Detail

constructor

public void constructor()

Description copied from interface: IClassifierInstance

The domain-specific constructor of the Classifier.

Specified by:

constructor in interface IClassifierInstance

Overrides:

constructor in class GUIContainerComponent

validate

public void validate()

Description copied from class: GUIComponent

Validates a configuration settings of this widget.

Overrides:

validate in class GUIContainerComponent

createSpecificInfo

public rs.sol.soloist.client.common.info.DialogInfo createSpecificInfo()

Description copied from class: GUIComponent

Creates and returns an empty serializable object of the appropriate ComponentInfo sub-class. The returned object must be able to transmit every property of objects of this class from server to clients (browsers).

Returns:

a ComponentInfo sub-class instance

create

public static GUIDialogComponent create(GUIApplicationComponent app,
                                        java.lang.String caption)

Returns new GUIDialogComponent with the given caption and assigns it to the given owner application.

Parameters:

app - the owner application

caption - the caption of the new dialog

Returns:

the new GUIDialogComponent

create

public static GUIDialogComponent create(GUIApplicationComponent app,
                                        java.lang.String caption,
                                        boolean modal)

Returns new GUIDialogComponent with the given caption and modality and assigns it to the given owner application.

Parameters:

app - the owner application

caption - the caption of the new dialog

modal - a boolean that tells whether new dialog should be modal or not

Returns:

the new GUIDialogComponent

ipHide

public ISlot<?> ipHide()

Returns the hide input pin; when event occurs, this dialog will get hidden.

The content of the binding message accepted on this pin is of no importance. Only event is what matters.

Returns:

the hide input pin

See Also:

GUIComponentBinding

ipCaption

public ISlot<?> ipCaption()

Returns the caption input pin; when event occurs, the textual content of the binding message will be used as the new caption of this dialog.

Returns:

the caption input pin

See Also:

GUIComponentBinding

getCaption

public java.lang.String getCaption()

Returns the caption of this dialog.

Returns:

the caption of this dialog

See Also:

setCaption(String)

setCaption

public void setCaption(java.lang.String caption)

Sets the caption of this dialog.

Parameters:

caption - the caption of this dialog

getModal

public boolean getModal()

Returns whether this dialog is modal or not.

Returns:

whether this dialog is modal or not

See Also:

setModal(boolean)

setModal

public void setModal(boolean modal)

Sets whether this dialog is modal or not.

Parameters:

modal - a boolean that tells whether this dialog is modal or not

getAutoHide

public boolean getAutoHide()

Returns whether the dialog should be automatically hidden when the user clicks outside of it.

Returns:

whether the dialog should be automatically hidden when the user clicks outside of it

See Also:

setAutoHide(boolean)

setAutoHide

public void setAutoHide(boolean autoHide)

Sets whether the dialog should be automatically hidden when the user clicks outside of it.

Parameters:

autoHide - a boolean that tells whether the dialog should be automatically hidden when the user clicks outside of it

getSingleton

@Deprecated
public boolean getSingleton()

Deprecated. Not for public use.

setSingleton

@Deprecated
public void setSingleton(boolean value)

Deprecated. Not for public use.

getOwner

@Deprecated
public GUIComponent getOwner()

Deprecated. Not for public use.

Description copied from class: GUIComponent

Returns the owner of this Component. This method requires that all association ends towards possible owners are navigable.

Overrides:

getOwner in class GUIComponent

isModal

@Deprecated
public boolean isModal()

Deprecated. Not for public use.

isAutoHide

@Deprecated
public boolean isAutoHide()

Deprecated. Not for public use.

isSingleton

@Deprecated
public boolean isSingleton()

Deprecated. Not for public use.