ActionBase

Base class for concrete action classes - Action and Partition. These sub-classes are semantically equivalent and differ only in diagram representation - Action is represented by a node, Partition by a container node. Action can be a child of another action or of an action category. It may contain content and action elements - abstract actions and action categories. It may also contain action mappings - logical names of actions referenced by this action’s content.

Supertypes

Subtypes

  • Action - Concrete action.
  • Partition - Concrete action class represented as a container node on a diagram containing actions and other partitions.

Members

Attributes

activator : EString

Activator is either a URL if the activator type is Reference, or a script if the activator type is Script or Bind.

The application generator generates a page for an action only if the activator type is Reference, the URL does not start with ./ and when resolved is relative to the base URI and below it. Using ./ is a way to reference externally generated content. For example, create a hierarchy/federation of sites.

For the reference activator type activator URL is resolved against the first ancestor action which also has reference activator type. If there is no such action, the URL is resolved against the base URI. During generation action URL is de-resolved against the base URI to produce a relative resource/file path.

${base-uri} token can be used in the activator to define the uri relative to the base generation URI (output folder) instead of the parent URI. It might be useful it the parent URI is an absolute external URI. ${base-uri} ends with a slash, so there is no need to add a slash. E.g. ${base-uri}index.html.

Type EString
Cardinality 0..1

activatorType : ActivatorType

Action activator type. Actions may have no activators. Activator and activator type settings are not used for actions in Section role.

Type ActivatorType
Cardinality 0..1

confirmation : EString

Confirmation to display in a confirmation dialog before action activation to give the user an opportunity to cancel the action. E.g. confirmation of deletion.

Type EString
Cardinality 0..1

disabled : EBoolean

If true, then action is displayed as disabled.

Type EBoolean
Cardinality 0..1

embedded : EBoolean

If true, then action content is displayed instead of the action label. For example, a login form action or a search action can be embedded into a navbar.

Type EBoolean
Cardinality 0..1

markdownContent : EString

Markdown text. If this attribute contains text, the text is converted to HTML, interpolated and used as the first content element. The primary purpose of this attribute is rapid development/prototyping of web applications/sites.

Type EString
Cardinality 0..1

pageTemplate : EString

URI of the page template to use for generation of a Web Application. The URI is resolved relative to the action’s containing resource. Defaults to platform:/plugin/org.nasdanika.vinci.templates/pages/default/primary.vinci built-in template.

Built-in page templates

org.nasdanika.vinci.templates plugin, which is part of the Vinci distribution, provides the following page templates (organized by theme and header color):

  • Default
    • Primary
      • platform:/plugin/org.nasdanika.vinci.templates/pages/default/primary.vinci
      • platform:/plugin/org.nasdanika.vinci.templates/pages/default/primary-fluid.vinci - fluid container.
  • Cerulean
    • Primary
      • platform:/plugin/org.nasdanika.vinci.templates/pages/cerulean/primary.vinci
      • platform:/plugin/org.nasdanika.vinci.templates/pages/cerulean/primary-fluid.vinci - fluid container.
      • platform:/plugin/org.nasdanika.vinci.templates/pages/cerulean/primary-dark.vinci - dark navigation bar.
      • platform:/plugin/org.nasdanika.vinci.templates/pages/cerulean/primary-dark-fluid.vinci - dark navigation bar, fluid container.
    • Dark
      • platform:/plugin/org.nasdanika.vinci.templates/pages/cerulean/dark.vinci
      • platform:/plugin/org.nasdanika.vinci.templates/pages/cerulean/dark-fluid.vinci - fluid container.
Type EString
Cardinality 0..1

role : EString

Action roles are used in “wiring” of actions into the generated Web UI.

For the root action its children are displayed depending on their rolw as follows:

  • Navigation:
    • The first navigation child is called “Principal” and is displayed in the navbar brand.
    • The remaining navigation children are displayed in navs on the right in the header.
  • Context children are displayed in the footer.

For the principal action (the first navigation child of the root action):

  • Navigation actions are displayed in the navigation panel on the left.
  • Context actions are displayed in the navbar.

For other non-section actions navigation children are displayed in the navigation panel and context children are displayed in right-floating navs on the top of the content panel.

Section actions are displayed as part of the content panel body of their parent. Their navigation children are treated as sections and display of their context children depends on the section style.

Content left and Content right acitons are displayed on the left and right of the content body respectively.

View and Edit actions are applicable for properties and property sources.

Type EString
Cardinality 0..1

sectionColumns : EInt

Applicable to section style “Card”. Defines how many columns shall be in a row of section cards.

Type EInt
Cardinality 0..1

sectionStyle : EString

Defines how to generate section children.

Type EString
Cardinality 0..1

References

content : ISupplierFactory<EJavaObject>*

Action content.

Type ISupplierFactory<T> <EJavaObject>
Cardinality 0..*