import {ControlLogicMixin} from 'guide4you/src/controls/ControlLogicMixin.js'

public class | source

ControlLogicMixin

Direct Subclass:

RewireMixin

This class contains logic which should be part of any Control in the Software. Any custom controls should inherit from Control which inherits from this class AND from ol.cont

Member Summary

Public Members
public	catched$Target_: *
public	singleButton: boolean

Private Members
private	className_: string
private	controlName_: string \| undefined
private	float_: string[] \| string
private	importance_: number
private	localiser_: L10N
private	tipLabel_: string \| undefined
private	title_: string \| undefined
private	visible_: boolean
private	windowed_: boolean

Method Summary

Public Methods
public	get$Element(): jQuery Returns the element of the control
public	get$Target(): jQuery Returns the target of the control
public	getClassName(): string Returns the CSS-className of the control
public	getControlName(): string Returns the name of the control if given to the constructor
public	getFloat(): string[] \| string Returns the floating directions of the control
public	getImportance(): number
public	getLocaliser(): L10N
public	getTipLabel(): string Returns the tipLabel of the control if given to the constructor
public	getTitle(): string Returns the title of the control if given to the constructor
public	getVisible(): boolean
public	initialize(options: g4uControlOptions)
public	isSingleButton(): Boolean Returns true if the element consists only of a single button
public	isWindowed(): boolean
public	set$Target($target: jQuery) Sets a new target for the control
public	setTipLabel(tipLabel: Localizable)
public	setTitle(title: Localizable)
public	setVisible(visible: boolean)

Public Members

public catched$Target_: * source

public singleButton: boolean source

Private Members

private className_: string source

private controlName_: string | undefined source

private float_: string[] | string source

private importance_: number source

private localiser_: L10N source

private tipLabel_: string | undefined source

private title_: string | undefined source

private visible_: boolean source

private windowed_: boolean source

Public Methods

public get$Element(): jQuery source

Returns the element of the control

Return:

jQuery

element it is created in

public get$Target(): jQuery source

Returns the target of the control

Return:

jQuery

element it is created in

public getClassName(): string source

Returns the CSS-className of the control

Return:

string

CSS-className

public getControlName(): string source

Returns the name of the control if given to the constructor

Return:

string

public getFloat(): string[] | string source

Returns the floating directions of the control

Return:

string[] | string

public getImportance(): number source

Return:

number

public getLocaliser(): L10N source

Return:

L10N

public getTipLabel(): string source

Returns the tipLabel of the control if given to the constructor

Return:

string

title

public getTitle(): string source

Returns the title of the control if given to the constructor

Return:

string

public getVisible(): boolean source

Return:

boolean

public initialize(options: g4uControlOptions) source

Params:

Name	Type	Attribute	Description
options	g4uControlOptions

public isSingleButton(): Boolean source

Returns true if the element consists only of a single button

Return:

Boolean

element it is created in

public isWindowed(): boolean source

Return:

boolean

public set$Target($target: jQuery) source

Sets a new target for the control

Params:

Name	Type	Attribute	Description
$target	jQuery		element it is moved to

public setTipLabel(tipLabel: Localizable) source

Params:

Name	Type	Attribute	Description
tipLabel	Localizable

public setTitle(title: Localizable) source

Params:

Name	Type	Attribute	Description
title	Localizable

public setVisible(visible: boolean) source

Params:

Name	Type	Attribute	Description
visible	boolean