NexusHoratio.web.StyleService

Members

---

logger :NexusHoratio.base.Logger

Details

Type

NexusHoratio.base.Logger

Inherited From

NexusHoratio.base.Service#logger

Overrides

NexusHoratio.base.Service#logger

Source

lib/base.js, line 2589

---

name :string

Details

Type

string

Inherited From

NexusHoratio.base.Service#name

Overrides

NexusHoratio.base.Service#name

Source

lib/base.js, line 2594

---

shortName :string

Details

Type

string

Inherited From

NexusHoratio.base.Service#shortName

Overrides

NexusHoratio.base.Service#shortName

Source

lib/base.js, line 2599

Methods

---

activate()

Description

Called each time service is activated.

Fires

NexusHoratio.base.Service#activate

NexusHoratio.base.Service#activated

Details

Inherited From

NexusHoratio.base.Service#activate

Overrides

NexusHoratio.base.Service#activate

Source

lib/base.js, line 2609

---

deactivate()

Description

Called each time service is deactivated.

Fires

NexusHoratio.base.Service#deactivate

NexusHoratio.base.Service#deactivated

Details

Inherited From

NexusHoratio.base.Service#deactivate

Overrides

NexusHoratio.base.Service#deactivate

Source

lib/base.js, line 2623

---

on( eventType, func ) → {NexusHoratio.base.Service}

Description

Attach a function to an eventType.

Parameters

Name	Type	Description
eventType	NexusHoratio.base.Dispatcher~EventType	Event type to connect with.
func	NexusHoratio.base.Dispatcher~Handler	Single argument function to call.

Returns

NexusHoratio.base.Service

This instance, for chaining.

Details

Inherited From

NexusHoratio.base.Service#on

Overrides

NexusHoratio.base.Service#on

Source

lib/base.js, line 2638

---

off( eventType, func ) → {NexusHoratio.base.Service}

Description

Remove all instances of a function registered to an eventType.

Parameters

Name	Type	Description
eventType	NexusHoratio.base.Dispatcher~EventType	Event type to disconnect from.
func	NexusHoratio.base.Dispatcher~Handler	Function to remove.

Returns

NexusHoratio.base.Service

This instance, for chaining.

Details

Inherited From

NexusHoratio.base.Service#off

Overrides

NexusHoratio.base.Service#off

Source

lib/base.js, line 2652

---

allowReactivation( allow ) → {NexusHoratio.base.Service}

Parameters

Name	Type	Description
allow	boolean	Whether to allow this service to be activated when already active.

Returns

NexusHoratio.base.Service

This instance, for chaining.

Details

Inherited From

NexusHoratio.base.Service#allowReactivation

Overrides

NexusHoratio.base.Service#allowReactivation

Source

lib/base.js, line 2662

---

setShortName( shortName ) → {NexusHoratio.base.Service}

Parameters

Name	Type	Description
shortName	string	Custom name portion of this instance.

Returns

NexusHoratio.base.Service

This instance, for chaining.

Details

Inherited From

NexusHoratio.base.Service#setShortName

Overrides

NexusHoratio.base.Service#setShortName

Source

lib/base.js, line 2671

Type Definitions

---

ElementMap

Details

Type

Map.<string, external:Element>

Source

lib/web.js, line 556

---

StyleProperties

Description

CSS style properties.

Details

Type

Map.<string, string>

Source

lib/web.js, line 561

---

Finder() → {NexusHoratio.web.StyleService~ElementMap}

Description

Function that finds DOM elements.

Returns

NexusHoratio.web.StyleService~ElementMap

Desired elements.

Details

Type

function

Source

lib/web.js, line 568

---

ElementsProcessor( elements ) → {NexusHoratio.web.StyleService~StyleProperties}

Description

Function that examines multiple elements to compute a style.

Parameters

Name	Type	Description
elements	NexusHoratio.web.StyleService~ElementMap	Elements to examine.

Returns

NexusHoratio.web.StyleService~StyleProperties

Style properties for to contribute.

Details

Type

function

Source

lib/web.js, line 576

---

Config

Properties

Name	Type	Attributes	Default	Description
className	string			Name for the class to control.
finder	NexusHoratio.web.StyleService~Finder			Function to find the elements to monitor.
elementsProcessor	NexusHoratio.web.StyleService~ElementsProcessor			Function that examines multiple elements to compute a style.
events	Array.<string>	<optional>	[]	List of Element events to listen to on the elements.

Details

Type

object

Source

lib/web.js, line 587

Events

---

activate

Details

Inherited From

NexusHoratio.base.Service#activate

Overrides

NexusHoratio.base.Service#activate

Source

lib/base.js, line 2685

---

activated

Details

Inherited From

NexusHoratio.base.Service#activated

Overrides

NexusHoratio.base.Service#activated

Source

lib/base.js, line 2688

---

deactivate

Details

Inherited From

NexusHoratio.base.Service#deactivate

Overrides

NexusHoratio.base.Service#deactivate

Source

lib/base.js, line 2691

---

deactivated

Details

Inherited From

NexusHoratio.base.Service#deactivated

Overrides

NexusHoratio.base.Service#deactivated

Source

lib/base.js, line 2694