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

java.lang.Object
  extended by rs.sol.soloist.server.uml.commonimplementation.runtime._ClassifierInstance
      extended by rs.sol.soloist.server.uml.commonimplementation.runtime._ClassInstance
          extended by rs.sol.soloist.server.javaimpl.runtime.SOLoistClassInstance
              extended by rs.sol.soloist.server.builtindomains.common.ObjectOfClass
                  extended by rs.sol.soloist.server.guiconfiguration.construction.GUIComponent
                      extended by rs.sol.soloist.server.guiconfiguration.components.GUIHTMLComponent
All Implemented Interfaces:
IElementPresentationProvider, IUpdatable, rs.sol.soloist.server.uml.concepts.IElement, IClassifierInstance, IClassInstance, IRTElement

public class GUIHTMLComponent
extends GUIComponent

A widget that contains an arbitrary HTML. Initial HTML content can be specified by calling setHTML(String) method. In the run-time, HTML content can dynamically change by binding other widget's output pin with this widget's html input pin (ipHTML() method).

Author:
SOL Expert Group

Nested Class Summary
static class GUIHTMLComponent.FQPropertyNames
          Deprecated. Not for public use.
static class GUIHTMLComponent.PROPERTIES
          Deprecated. Not for public use.
 
Field Summary
static IClass CLASSIFIER
          UML class reference
static java.lang.String FQ_TYPE_NAME
          Fully qualified UML class name
 IAttributeValue<Text> html
          Deprecated. Not for public use.
 
Fields inherited from class rs.sol.soloist.server.guiconfiguration.construction.GUIComponent
addStyle, context, description, enabled, init, inputBindings, layoutData, logger, name, outputBindings, ownerTable, parent, removeStyle, show, showInParent, styleName, tooltip, visible
 
Constructor Summary
GUIHTMLComponent()
           
GUIHTMLComponent(java.lang.String html)
          Deprecated. Not for public use.
 
Method Summary
 void constructor()
          The domain-specific constructor of the Classifier.
 void constructor(java.lang.String html)
          Performs an initialization for this object.
static GUIHTMLComponent create(GUIContainerComponent parent, java.lang.String html)
          Returns new GUIHTMLComponent with the given HTML content and assigns it to the given parent.
static GUIHTMLComponent create(GUIContainerComponent parent, java.lang.String html, int row, int column)
          Deprecated. Not for public use.
static GUIHTMLComponent create(GUIContainerComponent parent, java.lang.String html, int row, int column, int rowSpan, int colSpan)
          Deprecated. Not for public use.
static GUIHTMLComponent create(GUIContainerComponent parent, java.lang.String html, LayoutData layoutData)
          Returns new GUIHTMLComponent with the given HTML content, places it in the parent's layout according to the given LayoutData, and assigns it to the given parent.
 rs.sol.soloist.client.common.info.HTMLInfo createSpecificInfo()
          Creates and returns an empty serializable object of the appropriate ComponentInfo sub-class.
 java.lang.String getHTML()
          Returns this widget's HTML content.
 ISlot<?> ipHTML()
          Returns the HTML input pin; when event occurs, the HTML content from the binding message will be used to set this widget's HTML content.
 void setHTML(java.lang.String html)
          Sets this widget's HTML content.
 
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, getOwner, 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, validate, 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

html

@Deprecated
public IAttributeValue<Text> html
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

Constructor Detail

GUIHTMLComponent

@Deprecated
public GUIHTMLComponent(java.lang.String html)
Deprecated. Not for public use.


GUIHTMLComponent

public GUIHTMLComponent()
Method Detail

constructor

public void constructor(java.lang.String html)
Performs an initialization for this object. It is internally called during the construction.

Parameters:
html - the String containing an arbitrary HTML contnent to be displayed

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 GUIComponent

createSpecificInfo

public rs.sol.soloist.client.common.info.HTMLInfo 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 GUIHTMLComponent create(GUIContainerComponent parent,
                                      java.lang.String html)
Returns new GUIHTMLComponent with the given HTML content and assigns it to the given parent.

Parameters:
parent - the parent GUIContainerComponent widget
html - the widget's HTML
Returns:
new GUIHTMLComponent

create

public static GUIHTMLComponent create(GUIContainerComponent parent,
                                      java.lang.String html,
                                      LayoutData layoutData)
Returns new GUIHTMLComponent with the given HTML content, places it in the parent's layout according to the given LayoutData, and assigns it to the given parent.

Parameters:
parent - the parent GUIContainerComponent widget
html - the widget's HTML
layoutData - the layout data of the new button
Returns:
new GUIHTMLComponent

ipHTML

public ISlot<?> ipHTML()
Returns the HTML input pin; when event occurs, the HTML content from the binding message will be used to set this widget's HTML content.

Returns:
the HTML input pin
See Also:
GUIComponentBinding

getHTML

public java.lang.String getHTML()
Returns this widget's HTML content.

Returns:
this widget's HTML content
See Also:
setHTML(String)

setHTML

public void setHTML(java.lang.String html)
Sets this widget's HTML content.

Parameters:
html - new HTML content

create

@Deprecated
public static GUIHTMLComponent create(GUIContainerComponent parent,
                                                 java.lang.String html,
                                                 int row,
                                                 int column)
Deprecated. Not for public use.


create

@Deprecated
public static GUIHTMLComponent create(GUIContainerComponent parent,
                                                 java.lang.String html,
                                                 int row,
                                                 int column,
                                                 int rowSpan,
                                                 int colSpan)
Deprecated. Not for public use.