MViewStates

MViewStates ⇐ Trait#

Add states feature to View’s The View must support the ‘states’ class keyword and build the states in constructor by calling the buildStates method.

Kind: global mixin
Extends: Trait
Properties

• MViewStates ⇐ Trait
  • .buildStates()
  • .setState(state, [options])
  • ._changeState(newState, oldState)
  • .updateFSState([options])
  • .setStateOnPropertyChange(state, propertyPath, [options])
  • .getState() ⇒ String
  • .inState(stateName) ⇒ boolean
  • .addStates(states)
  • ._createStates(states)
  • ._normalizeCompoundState(states) ⇒ string
  • ._getStatesOfCompoundState(compoundStateName) ⇒ Array

buildStates()#

Build the states map. Must be called once when the View is constructed.

Kind: instance method of MViewStates

setState(state, [options])#

Set the new state Trigger event “change.state” only if the state has changed

// "default: { x: 10, y: 10, opacity:0, color: "#000000" }
// "stateA: { x: 500, opacity:0.5 }
// "stateB: { y: 500, opacity:1 }
// "stateA&stateB": { color: "#ffffff" }
// or "stateB&stateA"
view.setState("stateA"); // x=500, y=10, opacity=1, color: "#000000"
view.setState("stateB"); // x=10, y=500, opacity=1, color: "#000000"
view.setState("stateA&stateB"); // x=500, y=500, opacity=1, color: "#ffffff"
view.setState("stateB&stateA"); // x=500, y=500, opacity=0.5, color: "#ffffff"

Kind: instance method of MViewStates

_changeState(newState, oldState)#

Extension point Use it to set the states of the children These method will be deprecated when ‘state’ will be a property, ie when the writting of

"states": {
   "selected": {
      "myChild.state": "selected"
   }
}

will be supported

As of writting, you need to write it like this

Kind: instance method of MViewStates
Access: protected

Example

_changeState: function() {
   if(this.inState("selected")) {
      this.myChild.setState("selected");
   }
}

updateFSState([options])#

Apply a setState with current state to update focus and selected state

Kind: instance method of MViewStates

setStateOnPropertyChange(state, propertyPath, [options])#

Change the state when the value of the property change. You can choose the targeted state depending on the value of the property.

Kind: instance method of MViewStates

Example

setStateOnPropertyChange("state", "propertyPath")
setStateOnPropertyChange(data => data.value === true ? "state" : null, "propertyPath" )
setStateOnPropertyChange(data => data.value === true ? "state" : "default", "propertyPath")

getState() ⇒ String#

Return the array of states of the view or the state if not a compound state

Kind: instance method of MViewStates

inState(stateName) ⇒ boolean#

Return the true if the view is in the state.

Kind: instance method of MViewStates
Returns: boolean - true if the view is in the state

addStates(states)#

Dynamically add states definition

Kind: instance method of MViewStates

_createStates(states)#

Read the states definition and copy it to the internal states object property

Kind: instance method of MViewStates
Access: protected

_normalizeCompoundState(states) ⇒ string#

Normalize the name of a compound state, so that “stateA&stateB” and ‘stateB&stateA" refers to the same name The way it is normalized should have no consequence at all on the states functionality

Kind: instance method of MViewStates
Access: protected

_getStatesOfCompoundState(compoundStateName) ⇒ Array#

Return an array of states composed by the compound state /!\ IMPORTANT /!\ focused always at last

Kind: instance method of MViewStates
Access: protected