Class: Button

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

• new Button(options?)

▸ 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

▸ clone(): Button

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

Button

clone

▸ Protected copyConstructor(src): Button

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

Button

this

▸ getAction(): ActionCallback

Returns current action callback (if exists)

ActionCallback

▸ getBorder(): string

Returns button element border

string

▸ getChecked(): boolean

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

boolean

▸ getClassName(): string

string

▸ getColor(): string

Returns button element background color

string

▸ getElement(): HTMLElement

Returns current html DOM element used for the button

HTMLElement

▸ getHeight(): number

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

number

▸ getIcon(): string

Returns button icon

string

▸ getInit(): InitCallback

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

InitCallback

initialization callback

▸ 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[]

▸ getPaddingStyle(): string

Returns button element padding style

string

▸ getTextColor(): string

Returns button element text color

string

▸ getTitle(): string

Returns button DOM element title text

string

▸ getWidth(): number

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

number

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

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

Button

this

▸ setAction(action): Button

Sets current action callback

Button

this

▸ setBorder(border): Button

Sets button element border

Button

this

▸ setChecked(checked): Button

Adds or removes css checked class to the DOM element

Button

this

▸ setColor(color): Button

Sets button element background color

Button

this

▸ setIcon(icon): Button

Set button icon

Button

▸ setInit(init): Button

Sets initialization callback that is called on toolbar init/dispose

Button

this

▸ setPaddingStyle(padding): Button

Sets button element padding style

Button

▸ setSize(width, height?): Button

Sets button DOM element fixed size (in px)

Button

this

▸ setTextColor(color): Button

Sets button element text color

Button

this

▸ setTitle(title): Button

Sets button DOM element title

Button

▸ Static getClassName(): string

string