| Package | org.spicefactory.parsley.core.view |
| Interface | public interface ViewSettings |
| Implementors | DefaultViewSettings |
| Property | Defined By | ||
|---|---|---|---|
| autodestroyContext : Boolean
Indicates whether the Context should be automatically destroyed when the last view
root is removed from the ViewManager. | ViewSettings | ||
| autoremoveComponents : Boolean
Indicates whether components should be automatically removed from the ViewManager
when they are removed from the stage. | ViewSettings | ||
| autoremoveViewRoots : Boolean
Indicates whether view roots should be automatically removed from the ViewManager
when they are removed from the stage. | ViewSettings | ||
| autowireComponents : Boolean
Indicates wether components should be automatically wired. | ViewSettings | ||
| autowireFilter : ViewAutowireFilter
The filter responsible for selecting views that should be autowired to the Context. | ViewSettings | ||
| reuseComponents : Boolean
Indicates whether managed components will be reused after they have been
removed from the stage. | ViewSettings | ||
| viewProcessor : Service [read-only]
The view processor service registration for these settings. | ViewSettings | ||
| Method | Defined By | ||
|---|---|---|---|
addViewLifecycle(viewType:Class, lifecycle:Class, ... params):void
Adds a lifecycle handler class for a particular type of view component. | ViewSettings | ||
addViewRootHandler(handler:Class, ... params):void
Adds a view root handler that will be added to all ViewManagers created with these settings. | ViewSettings | ||
getViewRootHandlers(status:LookupStatus = null):Array
Returns all view root handlers that were registered for these settings. | ViewSettings | ||
Create a new lifecycle instance for the specified target object. | ViewSettings | ||
| autodestroyContext | property |
autodestroyContext:Boolean
Indicates whether the Context should be automatically destroyed when the last view
root is removed from the ViewManager. The default is true.
public function get autodestroyContext():Boolean public function set autodestroyContext(value:Boolean):void| autoremoveComponents | property |
autoremoveComponents:Boolean
Indicates whether components should be automatically removed from the ViewManager
when they are removed from the stage. The default is true.
When set to false components must dispatch a custom "removeView" event
to signal that they wish to be removed from the ViewManager.
public function get autoremoveComponents():Boolean public function set autoremoveComponents(value:Boolean):void| autoremoveViewRoots | property |
autoremoveViewRoots:Boolean
Indicates whether view roots should be automatically removed from the ViewManager
when they are removed from the stage. The default is true.
When set to false view roots must dispatch a custom "removeView" event
to signal that they wish to be removed from the ViewManager. Finally they can
be removed explicitly with ViewManager.removeViewRoot independent
of the value for this property.
public function get autoremoveViewRoots():Boolean public function set autoremoveViewRoots(value:Boolean):void| autowireComponents | property |
autowireComponents:Boolean
Indicates wether components should be automatically wired. The default is false.
When set to false, components can only be wired explicitly through the use of either the <Configure>
or the <FastInject> tags. When set to true, they will be automatically filtered using the
the filter specified with the autowireFilter property.
public function get autowireComponents():Boolean public function set autowireComponents(value:Boolean):void| autowireFilter | property |
autowireFilter:ViewAutowireFilter
The filter responsible for selecting views that should be autowired to the Context.
Only has an effect if the autowireComponents flag is set to true.
The default filter installed with Parsley is one that only wires views that
have a matching <View> tag in the MXML or XML configuration.
public function get autowireFilter():ViewAutowireFilter public function set autowireFilter(value:ViewAutowireFilter):void| reuseComponents | property |
reuseComponents:BooleanIndicates whether managed components will be reused after they have been removed from the stage. When set to false their configuration will only be processed once. This value should be true if the application keeps instances of the view in memory and adds them back to the stage later. It should be false (the default) if the view should get garbage collected once it has been removed from the stage.
public function get reuseComponents():Boolean public function set reuseComponents(value:Boolean):void| viewProcessor | property |
viewProcessor:Service [read-only] The view processor service registration for these settings. This hook allows to install alternative implementations to be used for processing all views in the associated Context and its children unless overwritten in a child.
When specifying an implementation or decorator for this service, it must implement the
ViewProcessor interface.
public function get viewProcessor():Service| addViewLifecycle | () | method |
public function addViewLifecycle(viewType:Class, lifecycle:Class, ... params):void
Adds a lifecycle handler class for a particular type of view component.
This hook allows to control the lifecycle differently than with the default
handler.
An example use case is an AIR window which has unreliable stage events,
so that it is safer to listen to its CLOSE event instead.
The specified lifecylce class must implement the ViewLifecycle interface.
Parameters
viewType:Class — the class for which to use the specified lifecycle class (this includes subclasses)
| |
lifecycle:Class — the lifecycle class to instantiate for each view instance
| |
... params — parameters to get passed to the constructor of the lifecylce class
|
| addViewRootHandler | () | method |
public function addViewRootHandler(handler:Class, ... params):void
Adds a view root handler that will be added to all ViewManagers created with these settings.
The provided class must implement the ViewRootHandler interface and provide
a no-arg constructor.
Parameters
handler:Class — the type of view handler to add
| |
... params — the parameters to pass to the constructor of the view handler
|
| getViewRootHandlers | () | method |
public function getViewRootHandlers(status:LookupStatus = null):Array
Returns all view root handlers that were registered for these settings.
This Array is read-only, modifications do not have any effect on
the registered view handlers. Use addViewRootHandler to
register a new handler.
Parameters
status:LookupStatus (default = null) |
Array — all view root handlers added to these settings
|
| newViewLifecycle | () | method |
public function newViewLifecycle(target:Object, status:LookupStatus = null):ViewLifecycleCreate a new lifecycle instance for the specified target object. If no lifecycle has been installed for the type of the target this method should return null.
Parameters
target:Object — the object for which to create a new lifecycle instance
| |
status:LookupStatus (default = null) |
ViewLifecycle — a new lifecycle instance for the specified target or null if no matching lifecycle has been installed
|