element <inline>

Namespace: | http://www.nokia.com/sdt/emf/component
Type: | embedded (extension of ConditionalSourceGenString)
Content: | simple, 5 attributes
Defined: | globally within component.xsd, see XML source
Used: | at 4 locations

XML Representation Summary
<inline
| forms | = | list of xsd:string
| id | = | xsd:string
| ifEvents | = | list of xsd:string
| ifExpr | = | xsd:string
| scope | = | xsd:string : "function"
| >
Content: | { xsd:string }
</inline>

May be included in elements (4):

  defineLocation, defineMacro, sourceGen, templateGroup

Known Usage Locations

- Within embedded complexTypes of elements (4):
  defineLocation [ref], defineMacro [ref], sourceGen [ref], templateGroup [ref]

Annotation
Provide Javascript in-line with templates and other sourceGen elements.
Be sure to supply a "forms" attribute, otherwise the code may execute multiple times
during the source generation contribution-gathering phase.
Embedded Type Detail

Type Derivation Summary xsd:string ConditionalSourceGenString (extension) complexType

Derivation: | extension of ConditionalSourceGenString

XML Source

<xsd:element name="inline"> <xsd:annotation> <xsd:documentation> Provide Javascript in-line with templates and other sourceGen elements. Be sure to supply a "forms" attribute, otherwise the code may execute multiple times during the source generation contribution-gathering phase. </xsd:documentation> </xsd:annotation> <xsd:complexType> <xsd:simpleContent> <xsd:extension base="ConditionalSourceGenString"> <xsd:attribute default="function" name="scope" type="xsd:string" use="optional"> <xsd:annotation> <xsd:documentation> Tells where the inline code appears. By default, it appears in the primary function into which templates are generated, thus is executed in line with them. Specifying "file" or "prototype" means the content is intended to modify the Javascript prototype, thus it is placed at the top level of the file. ${jsObject}.prototype may be used to access the prototype. Note: include() and includeFrom() calls should be placed in the prototype scope, or their contents will not be visible to derived components. Added post 1.1: "file" is a synonym for "prototype". </xsd:documentation> </xsd:annotation> </xsd:attribute> <xsd:attribute name="id" type="xsd:string" use="optional"> <xsd:annotation> <xsd:documentation> Added post 1.1: the identifier for the inline section, which makes it inheritable. Inline sections are inherited as templates, accessible with "useTemplate" of the same id. If unspecified, a default id is assigned. Use a blank id to avoid inheriting. </xsd:documentation> </xsd:annotation> </xsd:attribute> </xsd:extension> </xsd:simpleContent> </xsd:complexType> </xsd:element>

Attribute Detail
forms

  Added post 1.1 to inline.
  A list of tokens used to select a particular kind of source for a parent.
  The namespace is determined implicitly by what a parent requests.
  For instance, a parent may have special sourcegen, and pass
  the form "SpecialCase" to its children. Elements specifying
  form="SpecialCase" will be selected. Other parents will not see
  such elements if they do not specify that form.
  If the form does not match, the element is not invoked.

  Type: | listOfStrings
  Use: | optional
  Defined: | locally, within ConditionalSourceGenAttributes attributeGroup

id

  Added post 1.1: the identifier for the inline section,
  which makes it inheritable. Inline sections are inherited as templates,
  accessible with "useTemplate" of the same id.
  If unspecified, a default id is assigned. Use a blank id to avoid inheriting.

  Type: | xsd:string
  Use: | optional
  Defined: | locally, within this element

  XML Source

  <xsd:attribute name="id" type="xsd:string" use="optional"> <xsd:annotation> <xsd:documentation> Added post 1.1: the identifier for the inline section, which makes it inheritable. Inline sections are inherited as templates, accessible with "useTemplate" of the same id. If unspecified, a default id is assigned. Use a blank id to avoid inheriting. </xsd:documentation> </xsd:annotation> </xsd:attribute>

ifEvents

  Added post 1.1 to inline.
  If defined, a list of events, any of which must be bound for the
  element to be invoked.

  Type: | listOfStrings
  Use: | optional
  Defined: | locally, within ConditionalSourceGenAttributes attributeGroup

ifExpr

  Added post 1.1.
  If defined, a Javascript expression which must evaluate to
  true (or non-zero) for the element to be invoked.

  Type: | xsd:string
  Use: | optional
  Defined: | locally, within ConditionalSourceGenAttributes attributeGroup

scope

  Tells where the inline code appears. By default, it appears
  in the primary function into which templates are generated, thus is
  executed in line with them.
  Specifying "file" or "prototype" means the content is intended to modify the
  Javascript prototype, thus it is placed at the top level of the file.
  ${jsObject}.prototype may be used to access the prototype.
  Note: include() and includeFrom() calls should be placed in the prototype scope,
  or their contents will not be visible to derived components.
  Added post 1.1: "file" is a synonym for "prototype".

  Type: | xsd:string
  Use: | optional
  Default: | "function"
  Defined: | locally, within this element

  XML Source

  <xsd:attribute default="function" name="scope" type="xsd:string" use="optional"> <xsd:annotation> <xsd:documentation> Tells where the inline code appears. By default, it appears in the primary function into which templates are generated, thus is executed in line with them. Specifying "file" or "prototype" means the content is intended to modify the Javascript prototype, thus it is placed at the top level of the file. ${jsObject}.prototype may be used to access the prototype. Note: include() and includeFrom() calls should be placed in the prototype scope, or their contents will not be visible to derived components. Added post 1.1: "file" is a synonym for "prototype". </xsd:documentation> </xsd:annotation> </xsd:attribute>