Class: Label

• [new Label(options)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.controls.toolbar.label.label.md#new label(options))

• new Label(options?)

Button.constructor

▸ clear(tools, registry): void

Clears this button, removes all listeners and button DOM element from the document.<br> Calls user callback with the ToolsContainer provided and 'false' flag to clear the data. Removes itself from the registry list.

void

Button.clear

▸ clone(): Button

All subclasses should override copyConstructor or provide custom implementation for this method

Button

clone

Button.clone

▸ Protected copyConstructor(src): Label

Copy constructor function.<br> Function used as part of the cloning mechanism.<br> Implementations should copy the given instance state to this instance.<br>

Label

this

Button.copyConstructor

▸ getAction(): ActionCallback

Returns current action callback (if exists)

ActionCallback

Button.getAction

▸ getBorder(): string

Returns button element border

string

Button.getBorder

▸ getChecked(): boolean

Returns true if button is checked (for checkbox case), false otherwise

boolean

Button.getChecked

▸ getClassName(): string

string

Button.getClassName

▸ getColor(): string

Returns button element background color

string

Button.getColor

▸ getElement(): HTMLElement

Returns current html DOM element used for the button

HTMLElement

Button.getElement

▸ getHeight(): number

Returns fixed button height in px (if was set), null otherwise

number

Button.getHeight

▸ getIcon(): string

Returns button icon

string

Button.getIcon

▸ getInit(): InitCallback

Returns current initialization callback to be called on toolbar init/dispose

InitCallback

initialization callback

Button.getInit

▸ getName(): string[]

Returns current name(s) that describe group(s) that the radio button belongs to (checkbox case only). If the button should not switch automatically or is not checkbox, returns empty array

string[]

Button.getName

▸ getPaddingStyle(): string

Returns button element padding style

string

Button.getPaddingStyle

▸ getTextColor(): string

Returns button element text color

string

Button.getTextColor

▸ getTitle(): string

Returns button DOM element title text

string

Button.getTitle

▸ getWidth(): number

Returns fixed button width in px (if was set), null otherwise

number

Button.getWidth

▸ init(tools, registry, parent, gap, insertId, listener): Label

Initializes button, creates event listeners and adds button element to the document

Label

this

Button.init

▸ setAction(action): Label

Sets current action callback

Label

this

Button.setAction

▸ setBorder(border): Label

Sets button element border

Label

this

Button.setBorder

▸ setChecked(checked): Label

Adds or removes css checked class to the DOM element

Label

this

Button.setChecked

▸ setColor(color): Label

Sets button element background color

Label

this

Button.setColor

▸ setIcon(icon): Label

Set button icon

Label

Button.setIcon

▸ setInit(init): Label

Sets initialization callback that is called on toolbar init/dispose

Label

this

Button.setInit

▸ setPaddingStyle(padding): Label

Sets button element padding style

Label

Button.setPaddingStyle

▸ setSize(width, height?): Label

Sets button DOM element fixed size (in px)

Label

this

Button.setSize

▸ setText(text): Label

Set label text

Label

▸ setTextColor(color): Label

Sets button element text color

Label

this

Button.setTextColor

▸ setTitle(title): Label

Sets button DOM element title

Label

Button.setTitle

▸ Static getClassName(): string

string

Button.getClassName