Show TOC

TransparentContainer PropertiesLocate this document in the navigation structure

Use

Properties in View Designer

  • ariaLandmark

    With this property you can define Accessible Rich Internet Applications (ARIA) landmarks for container UI elements Group, Tray, Panel, PanelStack, ScrollContainer, and TransparentContainer. You select the UI element function to enable users to navigate with a screen reader within your application. If you set the ariaLandmark property, ARIA landmarks are added to an HTML element by the role attribute.

    Value

    Description

    Application

    Web application area (in contrast to web document)

    Article

    Area consisting of an independent part of a document or a page (e.g. forum post, magazine article, web log entry, user comment)

    Banner

    Page header

    Complementary

    Area with supplementary information that supports the main content and is comprehensible without reference to this information

    Contentinfo

    Metadata that relates to the parent document (e.g. footnotes, copyright, or links to data protection statements)

    Form

    Elements that together make up a form.

    Main

    Main content area

    Navigation

    Elements to navigate within the document or to similar documents (e.g. links).

    None

    No landmark role

    Search

    Area with search function

  • isLayoutContainer

    Specifies whether the TransparentContainer functions as a layout container.

    Note

    If isLayout=true, the defaultButton does not work. This is checked in the development environment. defaultButtons can only be used if TransparentContainer.isLayoutContainer=false.

    • isLayoutContainer=true:

      The container is used for laying out the view, it does not have any semantic properties. In this case a defaultButton cannot be set, the focus cannot be set on the container, users cannot navigate to the container using the tab key, and in accessibility mode the container cannot be read by a screen reader.

    • isLayoutContainer=false:

      The container is used for the layout and represents a semantic grouping, for instance, it arranges labels and input fields in a form.

      In this case the TransparentContainer can be navigated to using the tab key, and it can also be read in accessibility mode, provided the relevant accessibility properties are set (see TransparentContainer). You can set a default button using the defaultButtonId property.

  • labeledBy

    ID specification of the SectionHeader. This property is used for non-layout containers (isLayoutContainer = false), to link a SectionHeader as the title control to this container. The link between an existing SectionHeader and a TransparentContainer using labeledBy is relevant for Accessibility.

  • explanation

    Help text displayed when the help mode is activated. This property can be personalized by administrators. More information: Explanation Property

  • scrollLeft

    Horizontal position of the scrollbar

    scrollLeft can only be set or read dynamically. It is not possible to bind scrollLeft to the context.

  • scrollTop

    Vertical position of the scrollbar

    scrollTop can only be set or read dynamically. It is not possible to bind scrollTop to the context.

Note

The following getter and setter methods are available to get or set the vertical and horizontal position of the scrollbar:

  • GET_SCROLL_LEFT: Gets the horizontal scroll position

  • GET_SCROLL_TOP: Gets the vertical scroll position

  • SET_SCROLL_LEFT: Sets the horizontal scroll position

  • SET_SCROLL_TOP: Sets the vertical scroll position

Note

The initial value of the attributes scrollLeft and scrollTop is -1. You can no longer reach this value by scrolling. This allows the application to determine whether the container has been scrolled or not. Therefore, the smallest value that can be reached after scrolling in either direction is 0.