Class TurboIconToggle<ViewType, DataType, ModelType, EmitterType>

Icon class for creating icon elements. TurboIcon

Type Parameters

ViewType extends TurboView = TurboView<any, any>
DataType extends object = object
ModelType extends TurboModel<DataType> = TurboModel
EmitterType extends TurboEmitter = TurboEmitter

Hierarchy (View Summary)

TurboIcon<ViewType, DataType, ModelType, EmitterType>
- TurboIconToggle

Constructors

constructor

new TurboIconToggle<
    ViewType extends
        TurboView<
            object,
            TurboModel<any, any, any, "array" | "map", MvcDataBlock<any, any>>,
            TurboEmitter<
                TurboModel<any, any, any, "array" | "map", MvcDataBlock<any, any>>,
            >,
        > = TurboView<
        any,
        any,
        TurboEmitter<
            TurboModel<any, any, any, "array" | "map", MvcDataBlock<any, any>>,
        >,
    >,
    DataType extends object = object,
    ModelType extends
        TurboModel<
            DataType,
            any,
            any,
            "array"
            | "map",
            MvcDataBlock<DataType, any>,
        > = TurboModel<any, any, any, "array" | "map", MvcDataBlock<any, any>>,
    EmitterType extends
        TurboEmitter<
            TurboModel<any, any, any, "array" | "map", MvcDataBlock<any, any>>,
        > = TurboEmitter<
        TurboModel<any, any, any, "array" | "map", MvcDataBlock<any, any>>,
    >,
>(): TurboIconToggle
Type Parameters
- ViewType extends TurboView<
      object,
      TurboModel<any, any, any, "array" | "map", MvcDataBlock<any, any>>,
      TurboEmitter<
          TurboModel<any, any, any, "array" | "map", MvcDataBlock<any, any>>,
      >,
  > = TurboView<
      any,
      any,
      TurboEmitter<
          TurboModel<any, any, any, "array" | "map", MvcDataBlock<any, any>>,
      >,
  >
- DataType extends object = object
- ModelType extends TurboModel<DataType, any, any, "array" | "map", MvcDataBlock<DataType, any>> = TurboModel<any, any, any, "array" | "map", MvcDataBlock<any, any>>
- EmitterType extends TurboEmitter<TurboModel<any, any, any, "array" | "map", MvcDataBlock<any, any>>> = TurboEmitter<TurboModel<any, any, any, "array" | "map", MvcDataBlock<any, any>>>
Returns TurboIconToggle
Inherited from TurboIcon.constructor
- Defined in node_modules/typescript/lib/lib.dom.d.ts:10156

Properties

`Static` `Readonly`config

config: TurboIconConfig = ...

Description

Static configuration object.

onLoaded

onLoaded: (element: Element) => void

type

type: string

Description

The type of the icon.

config

config: TurboIconConfig = ...

stopPropagationOnClick

stopPropagationOnClick: boolean = true

onToggle

onToggle: (value: boolean, el: TurboIconToggle) => void

selected

selected: boolean

Description

Whether the element is selected or not.

`Readonly`initialized

initialized: boolean

view

view: ViewType

Description

The view (if any) of the element. Only when initializing MVC.

model

model: ModelType

Description

The model (if any) of the element. Only when initializing MVC.

data

data: DataType

Description

The main data block (if any) attached to the element, taken from its model (if any). Only when initializing MVC.

dataId

dataId: string

Description

The ID of the main data block (if any) of the element, taken from its model (if any). Only when initializing MVC.

dataIndex

dataIndex: number

Description

The numerical index of the main data block (if any) of the element, taken from its model (if any). Only when initializing MVC.

`Readonly`dataSize

dataSize: number

Description

The size (number) of the main data block (if any) of the element, taken from its model (if any). Only when initializing MVC.

unsetDefaultClasses

unsetDefaultClasses: boolean

`Protected`mvc

mvc: Mvc<
    TurboIconToggle<ViewType, DataType, ModelType, EmitterType>,
    ViewType,
    DataType,
    ModelType,
    EmitterType,
> = ...

Description

The MVC handler of the element. If initialized, turns the element into an MVC structure.

`Readonly`onAttach

onAttach: Delegate<() => void> = ...

Description

Delegate fired when the element is attached to DOM.

`Readonly`onDetach

onDetach: Delegate<() => void> = ...

Description

Delegate fired when the element is detached from the DOM.

`Readonly`onAdopt

onAdopt: Delegate<() => void> = ...

Description

Delegate fired when the element is adopted by a new parent in the DOM.

Accessors

path

get path(): string
Returns string
Description
The path to the icon's source file.
Inherited from TurboIcon.path
- Defined in src/turboComponents/basics/icon/icon.ts:73

icon

set icon(value: string): void
Parameters
- value: string
Returns void
Description
The name (or path) of the icon. Might include the file extension (to override the icon's type). Setting it will update the icon accordingly.
Inherited from TurboIcon.icon
- Defined in src/turboComponents/basics/icon/icon.ts:84

iconColor

set iconColor(value: string): void
Parameters
- value: string
Returns void
Description
The assigned color to the icon (if any)
Inherited from TurboIcon.iconColor
- Defined in src/turboComponents/basics/icon/icon.ts:93

toggled

set toggled(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in src/turboComponents/basics/icon/iconToggle/iconToggle.ts:31

toggleOnClick

set toggleOnClick(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in src/turboComponents/basics/icon/iconToggle/iconToggle.ts:36

Methods

`Protected`loadSvg

loadSvg(path: string): Promise<SVGElement>
Parameters
- path: string
Returns Promise<SVGElement>
Inherited from TurboIcon.loadSvg
- Defined in src/turboComponents/basics/icon/icon.ts:111

`Protected`loadImg

loadImg(path: string): HTMLImageElement
Parameters
- path: string
Returns HTMLImageElement
Inherited from TurboIcon.loadImg
- Defined in src/turboComponents/basics/icon/icon.ts:115

`Protected`updateColor

updateColor(value?: string): void
Parameters
- value: string = ...
Returns void
Inherited from TurboIcon.updateColor
- Defined in src/turboComponents/basics/icon/icon.ts:119

`Protected`generateIcon

generateIcon(): void
Returns void
Inherited from TurboIcon.generateIcon
- Defined in src/turboComponents/basics/icon/icon.ts:123

toggle

toggle(): void
Returns void
- Defined in src/turboComponents/basics/icon/iconToggle/iconToggle.ts:41

`Protected`getPropertiesValue

getPropertiesValue<Type>(
    propertiesValue: Type,
    configFieldName?: string,
    defaultValue?: Type,
): Type
Protected
getPropertiesValue
Type Parameters
- Type
Parameters
- propertiesValue: Type
  The actual value; could be null.
- OptionalconfigFieldName: string
  The field name of the associated value in the static config. Will be returned if the actual value is null.
- OptionaldefaultValue: Type
  The default fallback value. Will be returned if both the actual and config values are null.
Returns Type
Description
Returns the value with some fallback mechanisms on the static config field and a default value.
Inherited from TurboIcon.getPropertiesValue
- Defined in src/turboElement/setup/default/default.types.ts:19

destroy

destroy(): void
Returns void
Inherited from TurboIcon.destroy
- Defined in src/turboElement/setup/default/default.types.ts:21

initialize

initialize(): void
initialize

Returns void
Description
Initializes the element.
Inherited from TurboIcon.initialize
- Defined in src/turboElement/setup/default/default.types.ts:27

`Static`configure

configure(value: TurboElementConfig): void
Parameters
- value: TurboElementConfig
  The object containing the new configurations.
Returns void
Description
Update the class's static configurations. Will only overwrite the set properties.
Inherited from TurboIcon.configure
- Defined in src/turboElement/turboElement.ts:59

`Protected`setupChangedCallbacks

setupChangedCallbacks(): void
Protected
setupChangedCallbacks

Returns void
Description
Setup method intended to initialize change listeners and callbacks.
Inherited from TurboIcon.setupChangedCallbacks
- Defined in src/turboElement/turboElement.ts:70

`Protected`setupUIElements

setupUIElements(): void
Protected
setupUIElements

Returns void
Description
Setup method intended to initialize all direct sub-elements attached to this element, and store them in fields.
Inherited from TurboIcon.setupUIElements
- Defined in src/turboElement/turboElement.ts:79

`Protected`setupUILayout

setupUILayout(): void
Protected
setupUILayout

Returns void
Description
Setup method to create the layout structure of the element by adding all created sub-elements to this element's child tree.
Inherited from TurboIcon.setupUILayout
- Defined in src/turboElement/turboElement.ts:88

`Protected`setupUIListeners

setupUIListeners(): void
Protected
setupUIListeners

Returns void
Description
Setup method to initialize and define all input/DOM event listeners of the element.
Inherited from TurboIcon.setupUIListeners
- Defined in src/turboElement/turboElement.ts:96

connectedCallback

connectedCallback(): void
Returns void
Inherited from TurboIcon.connectedCallback
- Defined in src/turboElement/turboElement.ts:99

disconnectedCallback

disconnectedCallback(): void
Returns void
Inherited from TurboIcon.disconnectedCallback
- Defined in src/turboElement/turboElement.ts:103

adoptedCallback

adoptedCallback(): void
Returns void
Inherited from TurboIcon.adoptedCallback
- Defined in src/turboElement/turboElement.ts:107

Class TurboIconToggle<ViewType, DataType, ModelType, EmitterType>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Returns TurboIconToggle

Properties

Static Readonlyconfig

Description

onLoaded

type

Description

directory

Description

config

stopPropagationOnClick

onToggle

selected

Description

Readonlyinitialized

view

Description

model

Description

data

Description

dataId

Description

dataIndex

Description

ReadonlydataSize

Description

unsetDefaultClasses

Protectedmvc

Description

ReadonlyonAttach

Description

ReadonlyonDetach

Description

ReadonlyonAdopt

Description

Accessors

path

Returns string

Description

icon

Parameters

Returns void

Description

iconColor

Parameters

Returns void

Description

toggled

Parameters

Returns void

toggleOnClick

Parameters

Returns void

Methods

ProtectedloadSvg

Parameters

Returns Promise<SVGElement>

ProtectedloadImg

Parameters

Returns HTMLImageElement

ProtectedupdateColor

Parameters

Returns void

ProtectedgenerateIcon

Returns void

toggle

Returns void

ProtectedgetPropertiesValue

`Static` `Readonly`config

`Readonly`initialized

`Readonly`dataSize

`Protected`mvc

`Readonly`onAttach

`Readonly`onDetach

`Readonly`onAdopt

`Protected`loadSvg

`Protected`loadImg

`Protected`updateColor

`Protected`generateIcon

`Protected`getPropertiesValue

`Static`configure

`Protected`setupChangedCallbacks

`Protected`setupUIElements

`Protected`setupUILayout

`Protected`setupUIListeners