rs.sol.soloist.server.guiconfiguration.construction
Class GUIComponentBinding

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

All Implemented Interfaces:

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

public class GUIComponentBinding
extends rs.sol.soloist.server.builtindomains.common.ObjectOfClass

A specification of a binding (interaction) between a pair of widget pins. It defines a path for propagation of events: when the value of a source pin of is changed, its value is implicitly propagated to the destination pin (it is set to the same value). Each widget has its own set of input and output pins. Output pins are actually a substitution for events and could be fetched using methods with op name prefix on the widget instances. Input pins correspond to actions that should be invoked after event occurs and could be fetched using methods with ip name prefix. Widget interaction is specfied by connecting output pin (event) of one widget with input pin (action) of the other. Widget binding mechanism is a replacement for the classical mechanism of event-handlers.

There are four forms of binding connections. The first one (create(ISlot, ISlot) method) is used for connecting two pins that belong to regular widgets:

 GUIComponentBinding.create(textBox.opValue(), label.ipLabel());
 
 

The second one (create(ISlot, GUIComponent, IProperty) method) is used to connect widget's output pin with a command's input pin. Instead of a pin of a command, it uses an instance of GUICommandComponent (which can also be a button or a menu item) and a property of the command itself.

 GUIComponentBinding.create(textBox.opValue(), btn, CmdDestroyObject.PROPERTIES.input);
 
 

The third form (create(GUIComponent, IProperty, ISlot) method) is the same as the second but with opposite direction.

 GUIComponentBinding.create(btn, CmdCreateObject.PROPERTIES.output, listOfObjects.ipElement());
 
 

The final form (create(GUIComponent, IProperty, GUIComponent, IProperty) method) is used to connect two commands. It uses two GUICommandComponent instances and two Command pins.

 GUIComponentBinding.create(btn1, CmdCreateObject.PROPERTIES.output, btn2, CmdSetSlot.PROPERTIES.source);
 
 

Author:

SOL Expert Group

Nested Class Summary

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

Field Summary

static IClass	CLASSIFIER UML class reference
IAssociationEndInstance<GUIComponent>	destComponent Deprecated. Not for public use.
IAttributeValue<Text>	destPropertyName Deprecated. Not for public use.
static java.lang.String	FQ_TYPE_NAME Fully qualified UML class name
IAssociationEndInstance<GUIBindingsFeature>	ownerFeature Deprecated. Not for public use.
IAssociationEndInstance<GUIComponent>	sourceComponent Deprecated. Not for public use.
IAttributeValue<Text>	sourcePropertyName Deprecated. Not for public use.

Constructor Summary

GUIComponentBinding()
Deprecated. Not for public use.

Method Summary

void	constructor() The domain-specific constructor of the Classifier.
static GUIComponentBinding	create(GUIBindingsFeature f, java.lang.String pin1, GUIComponent c2, java.lang.String pin2) Deprecated. Not for public use.
static GUIComponentBinding	create(GUIComponent c1, IProperty p1, GUIComponent c2, IProperty p2) Creates a binding that connects the source command's output pin and the destination command's input pin.
static GUIComponentBinding	create(GUIComponent c1, IProperty p1, ISlot pin2) Creates a binding that connects the source command's output pin and the destination widget's input pin.
static GUIComponentBinding	create(GUIComponent c1, java.lang.String pin1, GUIComponent c2, java.lang.String pin2) Deprecated. Not for public use.
static GUIComponentBinding	create(ISlot pin1, GUIComponent c2, IProperty p2) Creates a binding that connects the source widget's output pin and the destination command's input pin.
static GUIComponentBinding	create(ISlot pin1, ISlot pin2) Creates a binding that connects the source widget's output pin and the destination widget's input pin.
static GUIComponentBinding	create(rs.sol.soloist.server.builtindomains.common.ObjectOfClass o, java.lang.String name1, GUIComponent c2, java.lang.String name2) Deprecated. Not for public use.
rs.sol.soloist.client.common.info.ComponentBindingInfo	createInfo() Deprecated. Not for public use.
ISlot	getDestPin() Deprecated. Not for public use.
static rs.sol.soloist.server.builtindomains.common.ObjectOfClass	getPinOwner(ISlot pin, boolean source) Deprecated. Not for public use.
ISlot	getSourcePin() Deprecated. Not for public use.
void	setDestPin(ISlot slot) Deprecated. Not for public use.
void	setDestPin(java.lang.String name) Deprecated. Not for public use.
void	setSourcePin(ISlot slot) Deprecated. Not for public use.
void	setSourcePin(java.lang.String name) Deprecated. Not for public use.
void	validate() Deprecated. Not for public use.

Methods inherited from class rs.sol.soloist.server.builtindomains.common.ObjectOfClass

handle

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, destructor, 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, destructor, 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

sourcePropertyName

@Deprecated
public final IAttributeValue<Text> sourcePropertyName

Deprecated. Not for public use.

destPropertyName

@Deprecated
public final IAttributeValue<Text> destPropertyName

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

ownerFeature

@Deprecated
public final IAssociationEndInstance<GUIBindingsFeature> ownerFeature

Deprecated. Not for public use.

sourceComponent

@Deprecated
public final IAssociationEndInstance<GUIComponent> sourceComponent

Deprecated. Not for public use.

destComponent

@Deprecated
public final IAssociationEndInstance<GUIComponent> destComponent

Deprecated. Not for public use.

Constructor Detail

GUIComponentBinding

@Deprecated
public GUIComponentBinding()

Deprecated. Not for public use.

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 rs.sol.soloist.server.builtindomains.common.ObjectOfClass

setSourcePin

@Deprecated
public void setSourcePin(ISlot slot)

Deprecated. Not for public use.

Sets the source Pin in this binding.

setSourcePin

@Deprecated
public void setSourcePin(java.lang.String name)

Deprecated. Not for public use.

getSourcePin

@Deprecated
public ISlot getSourcePin()

Deprecated. Not for public use.

Returns the source pin in this binding.

setDestPin

@Deprecated
public void setDestPin(ISlot slot)

Deprecated. Not for public use.

Sets the destination Pin in this binding.

setDestPin

@Deprecated
public void setDestPin(java.lang.String name)

Deprecated. Not for public use.

getDestPin

@Deprecated
public ISlot getDestPin()

Deprecated. Not for public use.

Returns the destination pin in this binding.

create

public static GUIComponentBinding create(ISlot pin1,
                                         ISlot pin2)

Creates a binding that connects the source widget's output pin and the destination widget's input pin.

Parameters:

pin1 - the source widget's ouput pin

pin2 - the destination widget's input pin

Returns:

the created GUIComponentBinding object that connects the source output pin and destination input pin

validate

@Deprecated
public void validate()

Deprecated. Not for public use.

getPinOwner

@Deprecated
public static rs.sol.soloist.server.builtindomains.common.ObjectOfClass getPinOwner(ISlot pin,
                                                                                               boolean source)

Deprecated. Not for public use.

create

public static GUIComponentBinding create(ISlot pin1,
                                         GUIComponent c2,
                                         IProperty p2)

Creates a binding that connects the source widget's output pin and the destination command's input pin.

Parameters:

pin1 - the source widget's ouput pin

c2 - the destination command widget

p2 - the destination command input pin property

Returns:

the created GUIComponentBinding object that connects the source output pin and destination input pin

create

public static GUIComponentBinding create(GUIComponent c1,
                                         IProperty p1,
                                         ISlot pin2)

Creates a binding that connects the source command's output pin and the destination widget's input pin.

Parameters:

c1 - the source command widget

p1 - the source command ouput pin property

pin2 - the destination widget's input pin

Returns:

the created GUIComponentBinding object that connects the source output pin and destination input pin

create

public static GUIComponentBinding create(GUIComponent c1,
                                         IProperty p1,
                                         GUIComponent c2,
                                         IProperty p2)

Creates a binding that connects the source command's output pin and the destination command's input pin.

Parameters:

c1 - the source command widget

p1 - the source command ouput pin property

c2 - the destination command widget

p2 - the destination command input pin property

Returns:

the created GUIComponentBinding object that connects the source output pin and destination input pin

create

@Deprecated
public static GUIComponentBinding create(rs.sol.soloist.server.builtindomains.common.ObjectOfClass o,
                                                    java.lang.String name1,
                                                    GUIComponent c2,
                                                    java.lang.String name2)

Deprecated. Not for public use.

create

@Deprecated
public static GUIComponentBinding create(GUIBindingsFeature f,
                                                    java.lang.String pin1,
                                                    GUIComponent c2,
                                                    java.lang.String pin2)

Deprecated. Not for public use.

create

@Deprecated
public static GUIComponentBinding create(GUIComponent c1,
                                                    java.lang.String pin1,
                                                    GUIComponent c2,
                                                    java.lang.String pin2)

Deprecated. Not for public use.

createInfo

@Deprecated
public rs.sol.soloist.client.common.info.ComponentBindingInfo createInfo()

Deprecated. Not for public use.