Label extends RequiresEdgeDestination, VisibleThing

Examples

• HiddenFieldAsParameter.iaml (source)
  • Using a hidden Label element as a Parameter for executing an Operation. [HiddenFieldAsParameter]
• HiddenFieldSyncWire.iaml (source)
  • Connecting a hidden Label element with a SyncWire. [HiddenFieldSyncWire]
• IamlVisualElements.iaml (source)
  • An example model to render all VisibleThings in theIAML metamodel. [IamlVisualElements]
  • An example model to render all VisibleThings in theIAML metamodel. [IamlVisualElements] [from VisibleThing]

Implementation Notes

• By default, a Label is visible. [LabelHideShow]
• If a Label is already shown, calling the 'show'operation has no effect. [testShowLabel()]
• If a Label is contained within a Session, then thevisibility of this Label persists according to the Session. [LabelHideShowSession]
• If a Label is hidden, calling the 'hide'operation again will have no effect. [testHideThenHide()]
• If a Label is hidden, calling the 'show'operation will place it back into view. [testHideThenShow()]
• If a Label is hidden, the visibility of the Label willpersist, according to the overall Scope. [testHiddenPersists()]
• If a Label is hidden, the visibility of the Label willpersist, according to the overall Scope. [testHiddenPersists()]
• If a Label is shown, calling the 'hide'operation will hide it from view. [testHideLabel()]
• Any children of a Label are also rendered as part of that Label. [Label]
• The rendered value of a Label is selected from the following order: the set fieldValue; the set defaultValue; outgoing SyncWires; incoming SyncWires; or incoming SetWires. [Label]
• The value of Value 'fieldValue' of a Label overrides the value of the Label.defaultValue attribute. [Label]

Inference Rules

• An entry Gate can require a given Label to beset, creating a Frame that must be filled in before the containing Scopecan be accessed. [EntryGateRequiresOpenID]
• InputTextFields will contain a Label named 'Warning'. [validate]
• An InputForm connected to another InputForm with a SetWire will create a Label in the target form for every InputTextField in the source form with the same name. [set-wires]
• An InputForm connected to another InputForm with a SetWire will create a Label in the target form for every Label in the source form with the same name. [set-wires]
• When a DomainIterator is connected to an InputForm by a SetWire, Labels will be generated for its non-generated, non-primary key DomainAttributeInstances. [set-wires]
• An InputForm connected to another InputForm with a SyncWire will create a Label in the target form for every Label in the source form with the same name. [sync-wires]
• Accessible elements have an Event named onAccess. [events] [from Accessible]
• An ActivityOperation named 'permissions check' within an AccessControlHandler protecting a Session-contained Frame, used to check the status of the 'check permissions' Operation within the same handler, will be completed with the necessary ActivityNodes to implement this functionality. [users] [from Changeable]
• An ActivityPredicate named 'can cast?', used to check casting for a Changeable fieldValue, will be completed with the necessary ActivityNodes to implement this functionality. [casting] [from Changeable]
• An ActivityPredicate named 'permissions check' within an AccessControlHandler protecting a Frame, used to check the status of the 'check permissions' Operation within the same handler, will be completed with the necessary ActivityNodes to implement this functionality. [users] [from Changeable]
• An empty ActivityOperation named "update", "refresh" or "init", contained within a Changeable, will be completed with ActivityNodes to implement the particular operation. [operations] [from Changeable]
• An empty ActivityOperation named "set value XXX", contained within a Changeable, used to set a Value other than fieldValue, will be completed with ActivityNodes to implement the particular operation. [operations] [from Changeable]
• Changeable elements will contain a BuiltinProperty named 'can cast?'. [casting] [from Changeable]
• Changeable elements have an Event named onChange. [events] [from Changeable]
• A Changeable contains an untyped Value named fieldValue. [base] [from Changeable]
• If set, the defaultValue is used as the default value of the created fieldValue Value. [base] [from Changeable]
• A SetWire connecting an CanBeSynced object to a DomainIterator will create sub- SetWires between every contained CanBeSynced object to every contained object within the contained DomainInstance which have matching names. [set-wires] [from CanBeSynced]
• A SetWire connecting an DomainIterator to a CanBeSynced object will create sub- SetWires between every contained object within the contained DomainInstance to every contained CanBeSynced object which have matching names. [set-wires] [from CanBeSynced]
• A SetWire connecting two objects will create sub- SetWires between every contained object within these parent objects which have matching names. [set-wires] [from CanBeSynced]
• When a Changeable element is connected to an CanBeSynced element by a SetWire, the value of the source element will be provided as a Parameter to the updating ECARule. [set-wires] [from CanBeSynced]
• When a Changeable element is connected to an CanBeSynced element by a SetWire, the value of the source element will be provided as a Parameter to the updating ECARule. [set-wires] [from Changeable]
• When a CanBeSynced element is connected to an CanBeSynced element by a SetWire, the value of the source element will be provided as a Parameter to the updating ECARule. [set-wires] [from CanBeSynced]
• When a Changeable is connected to a Value by a SetWire, the source element will call the 'set value XXX' Operation on the target when the source changes. [set-wires] [from Changeable]
• When a Changeable element is connected to a Value by a SetWire, the value of the source element will be provided as a Parameter to the updating ECARule. [set-wires] [from Changeable]
• When an InputTextField is connected to a CanBeSynced element by an instant SetWire, the value of the source element will be provided as a Parameter to the updating ECARule. [set-wires] [from CanBeSynced]
• A SyncWire connecting an DomainIterator to a CanBeSynced object will create sub- SyncWires between every contained object within the contained DomainInstance to every contained CanBeSynced object which have matching names. [sync-wires] [from CanBeSynced]
• A SyncWire connecting two objects will create sub- SyncWires between every contained object within these parent objects which have matching names. [sync-wires] [from CanBeSynced]
• For elements connected by a SyncWire, the onAccess Event executing the 'init' Operation will only execute if the source fieldValue can be cast successfully. [casting] [from CanBeSynced]
• For elements connected by a SyncWire, the onAccess Event will only call the 'validate' Operation if the relevant fieldValue is set. [casting] [from CanBeSynced]
• When a CanBeSynced element is connected to an CanBeSynced element by a SyncWire, the value of the source element will be provided as a Parameter to the updating ECARule. [sync-wires] [from CanBeSynced]
• When an InputTextField is connected to a CanBeSynced element by an instant SyncWire, the value of the source element will be provided as a Parameter to the updating ECARule. [sync-wires] [from CanBeSynced]
• All VisibleThings (except IteratorLists and InputForms) will contain an Operation named "init". [operations] [from VisibleThing]
• A VisibleThing has a BuiltinOperation named hide. [visible] [from VisibleThing]
• A VisibleThing has a BuiltinOperation named show. [visible] [from VisibleThing]
• VisibleThings have an BuiltinProperty named empty. [visible] [from VisibleThing]
• VisibleThings have an BuiltinProperty named notEmpty. [visible] [from VisibleThing]
• VisibleThings have an Event named onClick. [visible] [from VisibleThing]
• VisibleThings have an Event named onInput. [visible] [from VisibleThing]
• All VisibleThings (except IteratorLists and InputForms) will contain an Operation named "update". [operations] [from VisibleThing]

Constraints

• "Contained fieldValue property has a default value, even though container already specifies one" [Checks.chk] [from Changeable]
• "Type '".+(toString(type.name)).+("' is incompatible with contained fieldValue type '").+(toString(fieldValue.type.name)).+("'") [Checks.chk] [from Changeable]
• "You should not have a contained Property named 'fieldValue', unless it is contained within the fieldValue containment feature" [Checks.chk] [from ContainsValues]

Attributes

Inherited Attributes

• defaultValue : EString (optional)
  The default value of the fieldValue. This value should be the same as the defaultValue of the contained fieldValue, and is provided to simplify end-user implementation.
• generatedRule : EString (optional)
  To assist in debugging, this attribute may be populated with the name of the model completion rule that created this element. More extensive traceability support may be provided in the future.
• id : EString (optional)
  A unique identifier for this model element. Should be globally unique.
• isGenerated : EBoolean (optional)
  Set to true if the current element has been generated.
• name : EString (optional)
  A non-unique string that names a given object.
• overridden : EBoolean (optional)
  If a GeneratesElements is overridden, then this element will not generate any elements directly.
• overriddenNames : EString (optional)
  When applying model completion, no NamedElements with these names will be generated by this element.
• renderOrder : EInt (optional)
  VisibleThings are rendered in an ascending renderOrder order.
• visible : EBoolean (optional)
  If false, this VisibleThing will not initially be rendered to the user, until it has been shown.

Children

Inherited Children

• children : [0...*] VisibleThing
  Interface elements may be composed of other interface elements.
• conditionEdges : [0...*] SimpleCondition
  A list of contained SimpleConditions.
• constraintEdges : [0...*] ConstraintEdge
  A list of contained ConstraintEdges.
• currentInput : [0...1] Value
  The transient value of the VisibleThing; for example, the current text input in a InputTextField before it has been committed. This is not always a valid type instance.
• ecaRules : [0...*] ECARule
  A list of contained ECARules.
• empty : [0...1] Predicate
  Returns false if the current fieldValue is both set and not empty.
• extendsEdges : [0...*] ExtendsEdge
  A list of contained ExecutionEdges.
• fieldValue : [0...1] Value
  The current value of this Changeable element. This is always a valid type instance.
• functions : [0...*] Function
  A list of contained Functions.
• notEmpty : [0...1] Predicate
  Returns true if the current fieldValue is both set and not empty.
• onAccess : [0...1] Event
  This Event is executed whenever it is accessed, which may occur many times within a single request.
• onChange : [0...1] Event
  This Event is triggered immediately after the fieldValue of this element is changed.
• onClick : [0...1] Event
  This Event is triggered when the user clicks a rendered user interface element.
• onInput : [0...1] Event
  This Event is triggered when the user modifies the current value of an interface element, but before it has been committed (as per the onChange event).
• operations : [0...*] Operation
  A list of contained Operations.
• parameterEdges : [0...*] Parameter
  A list of contained Parameters.
• providesEdges : [0...*] ProvidesEdge
  A list of contained ProvidesEdges.
• requiresEdges : [0...*] RequiresEdge
  A list of contained RequiresEdges.
• schemaEdges : [0...*] SchemaEdge
  A list of contained SchemaEdges.
• selectEdges : [0...*] SelectEdge
  A list of contained SelectEdges.
• values : [0...*] Value
  A list of contained Values.
• wires : [0...*] Wire
  A list of contained Wires.

References

Inherited References

• generatedBy : [0...*] GeneratesElements [opposite: generatedElements]
  A list of elements that generated this element; conversely, overriding the source will prevent this element from being created.
• generatedElements : [0...*] GeneratedElement [opposite: generatedBy]
  A list of GeneratedElements that this element has generated through model completion.
• inRequiresEdges : [0...*] RequiresEdge [opposite: to]
  A list of incoming RequiresEdges.
• inWires : [0...*] Wire [opposite: to]
  A list of incoming Wires.
• outParameterEdges : [0...*] Parameter [opposite: parameterValue]
  A list of outgoing Parameters.
• outWires : [0...*] Wire [opposite: from]
  A list of outgoing Wires.
• type : [0...1] EDataType
  The type of this Changeable element and its contained fieldValue.

Extensions

Inherited Extensions

• List[model::Operation] allContainerOperations(model::ContainsOperations this) [GeneratorExtensions.ext]
• List[model::Operation] allContainerOperations(model::VisibleThing this) [GeneratorExtensions.ext]
• availableInCurrentScript(model::WireSource source,model::WireDestination target) [GeneratorExtensions.ext]
• model::visual::Frame containingFrame(model::NamedElement this) [Extensions.ext]
• model::Scope containingScope(model::NamedElement this) [GeneratorExtensions.ext]
• model::visual::Frame frameContainingOperation(model::NamedElement this) [GeneratorExtensions.ext]
• onCurrentFrame(model::WireSource source,model::WireDestination target) [GeneratorExtensions.ext]
• onCurrentSession(model::WireSource source,model::WireDestination target) [GeneratorExtensions.ext]
• safeName(model::GeneratedElement this) [GeneratorExtensions.ext]
• simpleName(model::NamedElement this) [GeneratorExtensions.ext]