Class HTML_Panel

constructor

• new HTML_Panel(): HTML_Panel

  Returns HTML_Panel

StaticinvalidElements

StaticmapHeaderAfterElements

StaticvalidatorRegistered

StaticdeterminePage

• determinePage(element: HTMLElement): HTMLElement

  Retrieves the first ".CXPage"-HTMLElement above the given "element".

  Parameters

  • element: HTMLElement

    The HTMLElement to start the search from.

  Returns HTMLElement

  The ".CXPage"-HTMLElement containing the given "element".

Staticfunctionality

• functionality(toLoad: { [key: string]: unknown }, toProcess: Element): undefined

  This functionality transforms the tagged HTMLDivElement into a Panel. The panel's header, which is used to fold/unfold the panel, is an HTMLElement tagged with the CSS-Class "CodBi_HTML_Panel_Header" that is nested at most two levels within the tagged HTMLElement. Thus using a * XIMA-Text-Element as the header will provide the XIMA-Text/HTML-Editor for creating the header's content.

  Config Parameter:

  • Folded: States whether this panel is folded (TRUE) or unfolded (everything else) when it is loaded (defaults to TRUE).
  • CSSHeaderHover: The optional header's CSS:hover (defaults to { scale : 1.1 ;}).
  • CSSHeaderActive: The optional header's CSS:active (defaults to { scale : .9 ;}).
  • CSSHeaderUnfolded: The optional CSS to be applied onto the header when the panel is unfolded.
  • DCSSHeaderUnfolded: The optional Darkmode CSS to be applied onto the header when the panel is unfolded.
  • CSSAnimFadeINPanel: The optional animation to be applied onto the panel whenever the panel is unfolded.
  • CSSAnimFadeINPanelDuration: The optional animation's duration that is applied onto the panel whenever the panel is unfolded (defaults to 0s).
  • CSSAnimFadeINPanelEasing: The optional animation's easing function that is applied onto the panel whenever the panel is unfolded (defaults to "ease-in-out").
  • CSSAfterHeader: The CSS:after to be applied onto the header when the panel is folded.
  • CSSBeforeHeader: The CSS:before to be applied onto the header when the panel is folded (will be overwritten when required fields are contained by the panel).
  • CSSAfterHeaderContent: The CSS:after content to be applied onto the header when the panel is folded.
  • CSSBeforeHeaderContent: The CSS:before content to be applied onto the header when the panel is folded. (will be overwritten when required fields are contained by the panel).
  • CSSAfterHeaderContentUnfolded: The CSS:after content to be applied onto the header when the panel is unfolded.
  • CSSBeforeHeaderContentUnfolded: The CSS:after content to be applied onto the header when the panel is unfolded. (will be overwritten when required fields are contained by the panel).
  • CSSRequiredFieldsContent: The CSS:before content to applied onto the header if it contains a validation sensitive field.
  • CSSRequiredFields: The CSS:before to applied onto the header if it contains a validation sensitive field.
  • AutoHeaderTitle: The stringthe automatically generated header shall display.
  • AutoHeaderTitleSupplementsSpacer The string separating the actual title form all strings that're supplemented 'cause they're HTMLInputElement.values of HTMLInputElements tagged with the CSS-Class CodBi_HTML_Panel_AutoHeaderTitle_Supplement without any XFieldSets or XContainer in between.
  • AutoHeaderLevel: Which level of enclosing <h>s the "AutoHeaderTitle" shall have, e.g. to get a <h1> enclosure the value has to be 1.
  • ScrollBlock: Defines the logical position to scroll to when the panel is unfolded (start, center, end, nearest). Defaults to "nearest".
  • GenerateHeader: States whether a header shall be automatically generated. Defaults to FALSE.
  • Scroll States whether the view shall be scrolled when the panel unfolds. Default is FALSE.
  • Accordion If set, this panel becomes part of an accordion. All panels sharing the same accordion name will be folded when one of them is unfolded.

  Parameters

  • toLoad: { [key: string]: unknown }

    Provided by CodBi.checkAttributes / CodBi.loadConfig.
  • toProcess: Element

    Provided by CodBi.checkAttributes / CodBi.loadConfig.

  Returns undefined

  Throws

  A CodBiError if the tagged Element does not contain a child of CSS-Class "CodBi_HTML_Panel_Header".

StaticunfoldPanelAncestors

• unfoldPanelAncestors(from: HTMLElement): void

  Unfolds all HTML-Panels that are ancestors of the specified Element by simulating a click on their header if they're folded.

  Parameters

  • from: HTMLElement

    The Element to start the unfolding from.

  Returns void