Pages Taglib - Component Tags

Pages Editing Tags (cpp)

The tags to implement editing UI components such as dialogs are the subject of this tag description page. The tags for rendering the HTML code of a content component  are described in Pages Component Tags.

defineFrameObjects

the extended define objects tag for edit frame components

editAction

the action tag for the edit toolbars

Attributes

  • icon
    String
    optional
  • label
    String
    optional
  • condition
    String
    optional
  • action
    String
    optional
  • title
    String
    optional

    The title of the item.

editDialog

The EditDialogTag creates the HTML code for an edit dialog of a component.

Attributes

  • var
    String
    optional

    the name of the model variable; this name must be unique in the chosen scope

  • type
    String
    optional

    the full class name of the models Java class

  • scope
    String
    optional

    The scope in which the variable is stored: page (= default), request or session .

  • replace
    java.lang.Boolean
    optional

    if 'true' an existing value of the same type is replaced by a new instance otherwise an existing instance of the chosen type is reused

  • tagId
    String
    optional

    the optional DOM tree id for the HTML tag

  • title
    String
    optional

    The title of the item.

  • languageContext
    java.lang.Boolean
    optional
  • resource
    org.apache.sling.api.resource.Resource
    optional

    The rendered resource.

  • resourcePath
    String
    optional

    The path of the resource to edit; if it ends with * then the dialog is meant to create a new resource.

  • resourceType
    String
    optional
  • primaryType
    String
    optional
  • selector
    String
    optional
  • cssBase
    String
    optional

    specifies the 'cssBase' value and overwrites the default value derived from the component resource type

  • cssSet
    String
    optional

    the 'main' CSS class for the produced tag (hides the 'cssBase' class)

  • cssAdd
    String
    optional

    additional CSS classes added to the 'main' CSS class specified by the 'cssBase' or 'cssSet' attribute

  • submit
    String
    optional
  • validation
    String
    optional

    the validation action selector or an uri for server side validation

  • successEvent
    String
    optional

    the event key of the event to trigger after a successful change request

  • disabled
    java.lang.Object
    optional

editDialogGroup

Creates a group within an edit dialog.

Attributes

  • groupId
    String
    optional

    an identifier for the group

  • label
    String
    optional

    the label of the group

  • expanded
    java.lang.Boolean
    optional
  • disabled
    java.lang.Object
    optional

    can be used to disable the group

  • test
    java.lang.Object
    optional

    nothing is rendered if the test attribute value is "false' (general condition)

editDialogTab

Creates a tab witin an edit dialog.

Attributes

  • tabId
    String
    optional

    identifier of the tab

  • label
    String
    optional

    the label of the tab

  • disabled
    java.lang.Object
    optional

    can be used to disable the tab

  • test
    java.lang.Object
    optional

    nothing is rendered if the test attribute value is "false' (general condition)

editToolbar

Creates the html markup for an edit toolbar.

Attributes

  • var
    String
    optional

    the name of the model variable; this name must be unique in the chosen scope

  • type
    String
    optional

    the full class name of the models Java class

  • scope
    String
    optional

    The scope in which the variable is stored: page (= default), request or session .

  • replace
    java.lang.Boolean
    optional

    if 'true' an existing value of the same type is replaced by a new instance otherwise an existing instance of the chosen type is reused

  • tagId
    String
    optional

    the optional DOM tree id for the HTML tag

  • cssBase
    String
    optional

    specifies the 'cssBase' value and overwrites the default value derived from the component resource type

  • cssSet
    String
    optional

    the 'main' CSS class for the produced tag (hides the 'cssBase' class)

  • cssAdd
    String
    optional

    additional CSS classes added to the 'main' CSS class specified by the 'cssBase' or 'cssSet' attribute

invoke

the general action tag to embed action calls to the edit layer into a page

Attributes

  • tagName
    String
    optional

    the tag name to render the wrapping tag (default: 'div')

  • action
    String
    optional
  • actionUrl
    String
    optional
  • model
    com.composum.pages.commons.model.Model
    optional
  • resource
    org.apache.sling.api.resource.Resource
    optional
  • path
    String
    optional
  • resourceType
    String
    optional
  • test
    java.lang.Boolean
    optional

    nothing is rendered if the test attribute value is "false' (general condition)

  • cssSet
    String
    optional

    the 'main' CSS class for the produced tag (hides the 'cssBase' class)

  • cssAdd
    String
    optional

    additional CSS classes added to the 'main' CSS class specified by the 'cssBase' or 'cssSet' attribute

menuItem

the menu item action tag for the dropdown menus of the toolbars

Attributes

  • icon
    String
    optional
  • label
    String
    optional
  • condition
    String
    optional
  • action
    String
    optional
  • title
    String
    optional

    The title of the item.

  • test
    java.lang.Boolean
    optional

    nothing is rendered if the test attribute value is "false' (general condition)

multiwidget

the widget rendering tag for structured multi value properties

Attributes

  • label
    String
    optional
  • property
    String
    optional
  • i18n
    java.lang.Boolean
    optional
  • var
    String
    optional

    the name of the model variable; this name must be unique in the chosen scope

  • modelClass
    String
    optional
  • cssBase
    String
    optional

    specifies the 'cssBase' value and overwrites the default value derived from the component resource type

  • cssSet
    String
    optional

    the 'main' CSS class for the produced tag (hides the 'cssBase' class)

  • cssAdd
    String
    optional

    additional CSS classes added to the 'main' CSS class specified by the 'cssBase' or 'cssSet' attribute

treeAction

the action tag for the tree toolbars

Attributes

  • icon
    String
    optional
  • label
    String
    optional
  • condition
    String
    optional
  • action
    String
    optional
  • title
    String
    optional

    The title of the item.

  • test
    java.lang.Boolean
    optional

    nothing is rendered if the test attribute value is "false' (general condition)

treeMenu

the action menu tag for the tree toolbars

Attributes

  • key
    String
    optional
  • icon
    String
    optional
  • label
    String
    optional
  • condition
    String
    optional
  • title
    String
    optional

    The title of the item.

widget

the dialog widget rendering tag

Attributes

  • type
    String
    optional

    the full class name of the models Java class

  • label
    String
    optional
  • property
    String
    optional
  • name
    String
    optional
  • value
    java.lang.Object
    optional
  • i18n
    java.lang.Boolean
    optional
  • multi
    java.lang.Boolean
    optional
  • required
    java.lang.Boolean
    optional

    If true, the property is mandatory.

  • blank
    java.lang.Boolean
    optional

    If true, a blank property is stored, otherwise the property is removed if the value is blank.

  • hint
    String
    optional
  • disabled
    java.lang.Boolean
    optional
  • placeholder
    String
    optional
  • test
    java.lang.Object
    optional

    nothing is rendered if the test attribute value is "false' (general condition)

  • modelClass
    String
    optional

widgetForm

The form tag to use edit widgets in a normal HTML form.

Attributes

  • var
    String
    optional

    the name of the model variable; this name must be unique in the chosen scope

  • type
    String
    optional

    the full class name of the models Java class

  • scope
    String
    optional

    The scope in which the variable is stored: page (= default), request or session .

  • replace
    java.lang.Boolean
    optional

    if 'true' an existing value of the same type is replaced by a new instance otherwise an existing instance of the chosen type is reused

  • tagId
    String
    optional

    the optional DOM tree id for the HTML tag

  • formType
    String
    optional
  • action
    String
    optional
  • method
    String
    optional
  • encType
    String
    optional
  • validation
    String
    optional

    the validation action selector or an uri for server side validation

  • disabled
    java.lang.Object
    optional
  • cssBase
    String
    optional

    specifies the 'cssBase' value and overwrites the default value derived from the component resource type

  • cssSet
    String
    optional

    the 'main' CSS class for the produced tag (hides the 'cssBase' class)

  • cssAdd
    String
    optional

    additional CSS classes added to the 'main' CSS class specified by the 'cssBase' or 'cssSet' attribute