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

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.GUILinkComponent

All Implemented Interfaces:

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

public class GUILinkComponent
extends GUIComponent

A widget that represents an anchor element. The href, caption, and target properties can be initially specified by calling setHref(String) method, setCaption(String) method, and setTarget(String) method. In the run-time, these can change dynamically, by binding other widgets' text providing output pins with this widget's href, caption, and target input pins (methods ipHref(), ipCaption(), and ipTarget()). If the user clicks on the link, this widget will fire event on its openLink output pin (opOpenLink() method).

Author:

SOL Expert Group

Nested Class Summary

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

Field Summary

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>	href Deprecated. Not for public use.
IAttributeValue<Text>	openLink Deprecated. Not for public use.
IAttributeValue<Text>	target 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

GUILinkComponent()

Method Summary

void	constructor() The domain-specific constructor of the Classifier.
static GUILinkComponent	create(GUIContainerComponent parent, java.lang.String caption, java.lang.String href) Returns new GUILinkComponent with the specified caption and URL (href), and assigns it to the given parent.
static GUILinkComponent	create(GUIContainerComponent parent, java.lang.String caption, java.lang.String href, int row, int column) Deprecated. Not for public use.
static GUILinkComponent	create(GUIContainerComponent parent, java.lang.String caption, java.lang.String href, LayoutData layoutData) Returns new GUILinkComponent with the specified caption and URL (href), places it in the parent's layout according to the given LayoutData, and assigns it to the given parent.
static GUILinkComponent	create(GUIContainerComponent parent, java.lang.String caption, java.lang.String href, java.lang.String target) Returns new GUILinkComponent with the specified caption, URL (href), target window, and assigns it to the given parent.
static GUILinkComponent	create(GUIContainerComponent parent, java.lang.String caption, java.lang.String href, java.lang.String target, int row, int column) Deprecated. Not for public use.
static GUILinkComponent	create(GUIContainerComponent parent, java.lang.String caption, java.lang.String href, java.lang.String target, LayoutData layoutData) Returns new GUILinkComponent with the specified caption, URL (href), target window, places it in the parent's layout according to the given LayoutData, and assigns it to the given parent.
java.lang.String	getCaption() Returns the caption of this widget.
java.lang.String	getHref() Returns the URL of this widget.
java.lang.String	getTarget() Returns the target window of this widget.
ISlot<?>	ipCaption() Returns the caption input pin; when event occurs, the textual content of the binding message is used to set the caption of this widget.
ISlot<?>	ipHref() Returns the href input pin; when event occurs, the textual content of the binding message is used to set the URL (href) of this widget.
ISlot<?>	ipOpenLink() Returns the openLink input pin; when event occurs, the request for resource with the URL of this widget is issued by this widget (that is, by the browser).
ISlot<?>	ipTarget() Returns the target input pin; when event occurs, the textual content of the binding message is used to set the target window of this widget.
ISlot<?>	opOpenLink() Returns the openLink output pin; each time user clicks on a link, this widget signals to all interested widgets by providing an empty binding message to this pin.
void	setCaption(java.lang.String caption) Sets the caption of this widget
void	setHref(java.lang.String href) Sets the URL of this widget.
void	setTarget(java.lang.String target) Sets the target window of this widget.

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

target

@Deprecated
public IAttributeValue<Text> target

Deprecated. Not for public use.

href

@Deprecated
public IAttributeValue<Text> href

Deprecated. Not for public use.

caption

@Deprecated
public IAttributeValue<Text> caption

Deprecated. Not for public use.

openLink

@Deprecated
public IAttributeValue<Text> openLink

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

GUILinkComponent

public GUILinkComponent()

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 GUIComponent

create

public static GUILinkComponent create(GUIContainerComponent parent,
                                      java.lang.String caption,
                                      java.lang.String href)

Returns new GUILinkComponent with the specified caption and URL (href), and assigns it to the given parent.

Parameters:

parent - the parent GUIContainerComponent widget

caption - the caption of new widget

href - the URL of new widget

Returns:

the new GUILinkComponent

create

public static GUILinkComponent create(GUIContainerComponent parent,
                                      java.lang.String caption,
                                      java.lang.String href,
                                      LayoutData layoutData)

Returns new GUILinkComponent with the specified caption and URL (href), 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

caption - the caption of new widget

href - the URL of new widget

layoutData - the layout data of the new link

Returns:

the new GUILinkComponent

create

public static GUILinkComponent create(GUIContainerComponent parent,
                                      java.lang.String caption,
                                      java.lang.String href,
                                      java.lang.String target)

Returns new GUILinkComponent with the specified caption, URL (href), target window, and assigns it to the given parent.

Parameters:

parent - the parent GUIContainerComponent widget

caption - the caption of new widget

href - the URL of new widget

target - the target window of new widget

Returns:

the new GUILinkComponent

create

public static GUILinkComponent create(GUIContainerComponent parent,
                                      java.lang.String caption,
                                      java.lang.String href,
                                      java.lang.String target,
                                      LayoutData layoutData)

Returns new GUILinkComponent with the specified caption, URL (href), target window, 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

caption - the caption of new widget

href - the URL of new widget

target - the target window of new widget

layoutData - the layout data of the new link

Returns:

the new GUILinkComponent

ipHref

public ISlot<?> ipHref()

Returns the href input pin; when event occurs, the textual content of the binding message is used to set the URL (href) of this widget.

Returns:

the href input pin

See Also:

GUIComponentBinding

ipTarget

public ISlot<?> ipTarget()

Returns the target input pin; when event occurs, the textual content of the binding message is used to set the target window of this widget.

Returns:

the target input pin

See Also:

GUIComponentBinding

ipCaption

public ISlot<?> ipCaption()

Returns the caption input pin; when event occurs, the textual content of the binding message is used to set the caption of this widget.

Returns:

the caption input pin

See Also:

GUIComponentBinding

ipOpenLink

public ISlot<?> ipOpenLink()

Returns the openLink input pin; when event occurs, the request for resource with the URL of this widget is issued by this widget (that is, by the browser).

Returns:

the openLink input pin

See Also:

GUIComponentBinding

opOpenLink

public ISlot<?> opOpenLink()

Returns the openLink output pin; each time user clicks on a link, this widget signals to all interested widgets by providing an empty binding message to this pin.

Returns:

the openLink output pin

See Also:

GUIComponentBinding

getCaption

public java.lang.String getCaption()

Returns the caption of this widget.

Returns:

the caption of this widget

See Also:

setCaption(String)

getTarget

public java.lang.String getTarget()

Returns the target window of this widget.

Returns:

the target window of this widget

See Also:

setTarget(String)

getHref

public java.lang.String getHref()

Returns the URL of this widget.

Returns:

the URL of this widget

See Also:

setHref(String)

setTarget

public void setTarget(java.lang.String target)

Sets the target window of this widget.

Parameters:

target - the target window of this widget

setCaption

public void setCaption(java.lang.String caption)

Sets the caption of this widget

Parameters:

caption - the caption of this widget

setHref

public void setHref(java.lang.String href)

Sets the URL of this widget.

Parameters:

href - the URL of this widget

create

@Deprecated
public static GUILinkComponent create(GUIContainerComponent parent,
                                                 java.lang.String caption,
                                                 java.lang.String href,
                                                 int row,
                                                 int column)

Deprecated. Not for public use.

create

@Deprecated
public static GUILinkComponent create(GUIContainerComponent parent,
                                                 java.lang.String caption,
                                                 java.lang.String href,
                                                 java.lang.String target,
                                                 int row,
                                                 int column)

Deprecated. Not for public use.