new State()
wp.media.controller.State
A state is a step in a workflow that when set will trigger the controllers
for the regions to be updated as specified in the frame.
A state has an event-driven lifecycle:
'ready' triggers when a state is added to a state machine's collection.
'activate' triggers when a state is activated by a state machine.
'deactivate' triggers when a state is deactivated by a state machine.
'reset' is not triggered automatically. It should be invoked by the
proper controller to reset the state to its default.
- Source:
Extends
- Backbone.Model
Methods
-
<private> [undefined]()
-
- Overrides:
- Source:
-
<private> _deactivate()
-
- Since:
-
- 3.5.0
- Overrides:
- Source:
-
<private> _menu()
-
- Since:
-
- 3.5.0
- Overrides:
- Source:
-
<private> _postActivate()
-
- Since:
-
- 3.5.0
- Overrides:
- Source:
-
<private> _preActivate()
-
- Since:
-
- 3.5.0
- Overrides:
- Source:
-
<private> _ready()
-
- Since:
-
- 3.5.0
- Overrides:
- Source:
-
<private> _renderMenu(view)
-
Create a view in the media menu for the state.
Parameters:
Name Type Description viewmedia.view.Menu The menu view. - Since:
-
- 3.5.0
- Overrides:
- Source:
-
<private> _renderTitle()
-
- Since:
-
- 3.5.0
- Overrides:
- Source:
-
<private> _router()
-
- Since:
-
- 3.5.0
- Overrides:
- Source:
-
<private> _title()
-
- Since:
-
- 3.5.0
- Overrides:
- Source:
-
<private> _updateMenu()
-
- Since:
-
- 3.5.0
- Overrides:
- Source:
-
<abstract> activate()
-
Activate event callback.
- Since:
-
- 3.5.0
- Overrides:
- Source:
-
constructor()
-
Constructor.
- Since:
-
- 3.5.0
- Overrides:
- Source:
-
<abstract> deactivate()
-
Deactivate event callback.
- Since:
-
- 3.5.0
- Overrides:
- Source:
-
<abstract> ready()
-
Ready event callback.
- Since:
-
- 3.5.0
- Overrides:
- Source:
-
<abstract> reset()
-
Reset event callback.
- Since:
-
- 3.5.0
- Overrides:
- Source: