Class ConvenienceDomService

constructor

• new ConvenienceDomService(domService): ConvenienceDomService

• Parameters

  • domService: DomServiceIf

  Returns ConvenienceDomService

Readonly domService

Static focusBorderWidthInPx

addArrowDiv

• addArrowDiv(parent, arrow?, treeOptions?, rowIndex?, columnIndex?, areaIdent?): HTMLDivElement

• Parameters

  • parent: HTMLDivElement

  • arrow: TreeArrowType = "none"

  • treeOptions: TreeOptionsIf = ...

  • rowIndex: number = -1

  • columnIndex: number = -1

  • areaIdent: AreaIdent = "body"

  Returns HTMLDivElement

addCheckboxToDiv

• addCheckboxToDiv(parent, checkedType, areaIdent, rowIndex, ariaLabel?): HTMLDivElement

• Parameters

  • parent: HTMLDivElement

  • checkedType: CheckedType

  • areaIdent: AreaIdent

  • rowIndex: number

  • Optional ariaLabel: string

  Returns HTMLDivElement

addClass

• addClass(clazz, div): HTMLDivElement

• Parameters

  • clazz: string

  • div: HTMLDivElement

  Returns HTMLDivElement

addClasses

• addClasses(classes, div): HTMLDivElement

• Parameters

  • classes: undefined | string[]

  • div: HTMLDivElement

  Returns HTMLDivElement

addColumnBorderDivs

• addColumnBorderDivs(tableOptions, parent, geo, areaIdent, sideIdent): HTMLDivElement

• Parameters

  • tableOptions: TableOptionsIf

  • parent: HTMLDivElement

  • geo: GeoData

  • areaIdent: AreaIdent

  • sideIdent: SideIdent

  Returns HTMLDivElement

addColumnDiv

• addColumnDiv(para): HTMLDivElement

• Parameters

  • para: AddColumnDivPara

  Returns HTMLDivElement

addDiv

• addDiv(parent, geo, clazz?): HTMLDivElement

• Parameters

  • parent: HTMLDivElement

  • geo: GeoData

  • clazz: string = ""

  Returns HTMLDivElement

addFocusBorderDivs

• addFocusBorderDivs(parent, geo, style): HTMLDivElement

• Draws the focus frame of a cell: four divs with the class ge-table-focus-border (2 px, color --ge-table-focus-outline-color resp. --ge-table-focus-border). Hidden from screen readers – they get the focus through aria-activedescendant.

  Parameters

  • parent: HTMLDivElement

  • geo: GeoData

  • style: HtmlStyle

  Returns HTMLDivElement

addHorizontalBorder

• addHorizontalBorder(geo, parent, clazz?): HTMLDivElement

• Parameters

  • geo: GeoData

  • parent: HTMLDivElement

  • clazz: string = "ge-table-body-center-horizontal-border"

  Returns HTMLDivElement

addLabelDiv

• addLabelDiv(parent, text?, firstTreeColumn?, rowIndex?, columnIndex?, areaIdent?): HTMLDivElement

• Parameters

  • parent: HTMLDivElement

  • text: string = ""

  • firstTreeColumn: boolean = false

  • rowIndex: number = -1

  • columnIndex: number = -1

  • areaIdent: AreaIdent = "body"

  Returns HTMLDivElement

addRowDiv

• addRowDiv(divScope, geo, rowIndex?, areaIdent, sideIdent, text?): HTMLDivElement

• Parameters

  • divScope: DivScope

  • geo: GeoData

  • rowIndex: number = -1

  • areaIdent: AreaIdent

  • sideIdent: SideIdent

  • text: string = ""

  Returns HTMLDivElement

addSortedIcon

• addSortedIcon(parent, sorted?, sortedOptions?, columnIndex?): HTMLDivElement

• Parameters

  • parent: HTMLDivElement

  • sorted: SortState = ""

  • sortedOptions: SortedOptionsIf = ...

  • columnIndex: number = -1

  Returns HTMLDivElement

addVerticalBorder

• addVerticalBorder(geo, parent, clazz?): HTMLDivElement

• Parameters

  • geo: GeoData

  • parent: HTMLDivElement

  • clazz: string = "ge-table-body-center-vertical-border"

  Returns HTMLDivElement

appendRelativeChildDiv

• appendRelativeChildDiv(parent): DivScope

• Parameters

  • parent: HTMLDivElement

  Returns DivScope

appendText

• appendText(parent, text): HTMLElement

• Parameters

  • parent: HTMLDivElement

  • text: string

  Returns HTMLElement

applyDisplayBlockStyle

• applyDisplayBlockStyle(ele): HTMLDivElement

• Parameters

  • ele: HTMLDivElement

  Returns HTMLDivElement

applyDisplayNoneStyle

• applyDisplayNoneStyle(ele): HTMLDivElement

• Parameters

  • ele: HTMLDivElement

  Returns HTMLDivElement

applyStyle

• applyStyle(ele, style): HTMLDivElement

• Parameters

  • ele: HTMLDivElement

  • style: HtmlStyle

  Returns HTMLDivElement

applyStyleFullSize

• applyStyleFullSize(ele): HTMLDivElement

• Parameters

  • ele: HTMLDivElement

  Returns HTMLDivElement

applyStyleInPx

• applyStyleInPx(ele, geoData): HTMLDivElement

• Parameters

  • ele: HTMLDivElement

  • geoData: GeoData

  Returns HTMLDivElement

applyStyleNoPadding

• applyStyleNoPadding(ele): HTMLDivElement

• Parameters

  • ele: HTMLDivElement

  Returns HTMLDivElement

applyStyleOverflowAuto

• applyStyleOverflowAuto(overflowX?, overflowY?, ele): HTMLDivElement

• Parameters

  • overflowX: "auto" | "scroll" = "auto"

  • overflowY: "auto" | "scroll" = "auto"

  • ele: HTMLDivElement

  Returns HTMLDivElement

applyStylePosistionAbsolute

• applyStylePosistionAbsolute(ele): HTMLDivElement

• Parameters

  • ele: HTMLDivElement

  Returns HTMLDivElement

applyStylePosistionRelative

• applyStylePosistionRelative(ele): HTMLDivElement

• Parameters

  • ele: HTMLDivElement

  Returns HTMLDivElement

applyStyleString

• applyStyleString(div, style): void

• Parameters

  • div: HTMLDivElement

  • style: string

  Returns void

createAreaDivWithClass

• createAreaDivWithClass(clazz, parent, areaIdent, sideIdent): HTMLDivElement

• Parameters

  • clazz: string

  • parent: HTMLDivElement

  • areaIdent: AreaIdent

  • sideIdent: SideIdent

  Returns HTMLDivElement

createDivWithClass

• createDivWithClass(clazz, parent): HTMLDivElement

• Parameters

  • clazz: string

  • parent: HTMLDivElement

  Returns HTMLDivElement

getDirection

• getDirection(): ResolvedTableDirection

• The writing direction set with setDirection (default "ltr").

  Returns ResolvedTableDirection

  "ltr" or "rtl"

  Since

  1.1.98

getInlineStart

• getInlineStart(ele): number

• The position of an element from the inline start in px, as written by this service (style.left, right-to-left style.right); 0 if it has none.

  Parameters

  • ele: HTMLElement

    an element positioned by this service

  Returns number

  px

  Since

  1.1.98

removeAttribute

• removeAttribute(ele, key): HTMLElement

• Removes an attribute (via DomServiceIf.removeAttribute if the DOM service has it).

  Parameters

  • ele: HTMLElement

  • key: string

  Returns HTMLElement

  Since

  1.1.91

removeClass

• removeClass(clazz, div): HTMLDivElement

• Parameters

  • clazz: string

  • div: HTMLDivElement

  Returns HTMLDivElement

setAriaHidden

• setAriaHidden<T>(ele): T

• Hides a purely decorative element (border, hover, icon …) from screen readers: aria-hidden="true".

  Type Parameters

  • T extends HTMLElement

  Parameters

  • ele: T

  Returns T

  Since

  1.1.91

setAttribute

• setAttribute(div, key, value): HTMLDivElement

• Parameters

  • div: HTMLDivElement

  • key: string

  • value: string

  Returns HTMLDivElement

setDirection

• setDirection(direction): void

• Sets the writing direction of the table. All positions of the table are computed from the start of a row (x = 0 is the first column); in right-to-left this service writes them as right instead of left – in setStyle, applyStyle, applyStyleInPx and all add… methods – so that the whole table is mirrored. Called once by the table before anything is positioned.

  Parameters

  • direction: ResolvedTableDirection

    "ltr" or "rtl"

  Returns void

  Example

  const dom = new ConvenienceDomService(new SimpleDomService());
  dom.setDirection("rtl");
  const div = document.createElement("div");
  dom.setStyle(div, "left", "20px"); // div.style.right = "20px"
  Copy

  Since

  1.1.98

setStyle

• setStyle(el, style, value): any

• Parameters

  • el: any

  • style: string

  • value: any

  Returns any

toPhysicalStyleKey

• toPhysicalStyleKey(key): string

• The physical CSS property for a logical position key: in right-to-left left ↔ right, everything else as is.

  Parameters

  • key: string

    a CSS property

  Returns string

  the property to write

  Since

  1.1.98