H.ui.Control

onUnitSystemChange (unitSystem)

This abstract method can be overridden by deriving classes to be invoked when the UI object distance measurement system changes.

onMapEngineTypeChange (engineType)

This abstract method can be overridden by deriving classes to be invoked when the underlying map engine changes.

getMap () : {?H.Map}

This method retrieves the map object to which the given control is attached.

Note: This method returns null if called before any controls have been added to a UI object.

getLocalization () : {H.ui.i18n.Localization}

This method retrieves the localization object which corresponds to the current locale of the UI.

getAlignment () : {H.ui.LayoutAlignment}

This method retrieves a value indicating layout alignment for the given control.

setAlignment (alignment) : {H.ui.Control}

This method sets the layout alignment for the given control.

The alignment within the map view port can be:

+--------------------------------------------------------------------------------+
|  "top-left"  > >       < <  "top-center"  > >      < <  "top-right"  |
|  "lef-ttop"                             "right-top"  |
|  v                                      v  |
|  v                                      v  |
|                                        |
|                                        |
|  ^                                      ^  |
|  ^                                      ^  |
|  "left-middle"                         "right-middle"  |
|  v                                      v  |
|  v                                      v  |
|                                        |
|                                        |
|  ^                                      ^  |
|  ^                                      ^  |
|  "left-bottom"                         "right-bottom"  |
|  "bottom-left"  > >     < <  "bottom-center"  > >     < <  "bottom-right"  |
+--------------------------------------------------------------------------------+

Elements with the same layout alignments are lined up in the directions of the arrows in the illustration.

addChild (child) : {H.ui.base.Container}

This method adds a child element to be rendered within the given container element.

getChildren () : {Array<H.ui.base.Element>}

This method retrieves the child element collection of the given container.

removeChild (child)

This method removes a child element from the given container's child element collection.

addEventListener (type, handler, opt_capture, opt_scope)

This method sets a listener for a specific event triggered by the given element.

removeEventListener (type, handler, opt_capture, opt_scope)

This method removes a previously added listener from the event target.

renderInternal (element, doc)

This method is the concrete implementation of the UI element. It receives the pre-rendered HTML element which may be modified by deriving classes.

isDisabled () : {boolean}

This method retrieves a value indicating if the given UI element is disabled.

setDisabled (disabled, opt_force) : {H.ui.base.Element}

This method sets a value indicating if the given UI element is disabled.

getData () : {*}

This method retrieves previously stored arbitrary data from the given element.

setData (data)

This method stores arbitrary data with the given UI element.

getElement () : {?HTMLElement}

This method retrieves the HTML element the given UI element renders.

Note: If the UI element has not been rendered, the method retrieves null.

setVisibility (visibility)

This method sets a value indicating if the given element is visible.

getVisibility () : {boolean}

This method retrieves a value indicating if the given element is visibile.

addClass (className) : {H.ui.base.Element}

This method adds a CSS class to the given UI element (if it is not already present).

removeClass (className) : {H.ui.base.Element}

This method removes a CSS class from the given UI element (if it is present).