| Package | com.flexicious.controls.containers |
| Class | public class VBox |
| Inheritance | VBox  mx.containers.VBox |
| Implements | IFilterControlContainer, IDataBoundContainer |
| Property | Defined By | ||
|---|---|---|---|
| _dataBoundContainerInterface : DataBoundContainerImpl | VBox | ||
| _filterContainerInterface : FilterContainerImpl | VBox | ||
| Method | Defined By | ||
|---|---|---|---|
applyChanges():void | VBox | ||
clearFilter():void
Clears all the filters
| VBox | ||
getFilterArguments():ArrayCollection
Loops through all registered IFilterControls, and creates a filter
| VBox | ||
getFilterControls():ArrayCollection
Returns all the filter controls
| VBox | ||
getFilterValue(column:String):*
Used to set the initial value of the filter. | VBox | ||
getNextFocusableFilter(myIndex:int, forward:Boolean, inclusive:Boolean = false):IFocusManagerComponent
Gets the next focusable filter control starting at myIndex, proceeding in
forward or backward direction based on the forward parameter
| VBox | ||
hasField(column:String):Boolean
Returns true if the container has a filter control
that is bound to the specified column. | VBox | ||
processFilter():void
In client mode, applies all the filters
| VBox | ||
registerIDataBoundControl(iDataBoundControl:IDataBoundControl):void
Registers the IDataBoundControl control in our list. | VBox | ||
registerIFilterControl(iFilterControl:IFilterControl):void
Registers the IFilter control in our list. | VBox | ||
setFilterFocus(fld:String):Boolean | VBox | ||
setFilterValue(column:String, value:Object):void
Used to set the initial value of the filter. | VBox | ||
setFocusOnNextFocusableControl(myIndex:int, forward:Boolean, inclusive:Boolean = false):Boolean
Sets the focus on the next focusable filter control starting at myIndex, proceeding in
forward or backward direction based on the forward parameter
| VBox | ||
unRegisterIFilterControl(iFilterControl:IFilterControl):void
Registers the IFilter control in our list. | VBox | ||
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| VBox | ||||
| _dataBoundContainerInterface | property |
protected var _dataBoundContainerInterface:DataBoundContainerImpl| _filterContainerInterface | property |
protected var _filterContainerInterface:FilterContainerImpl| applyChanges | () | method |
public function applyChanges():void| clearFilter | () | method |
public function clearFilter():voidClears all the filters
| getFilterArguments | () | method |
public function getFilterArguments():ArrayCollectionLoops through all registered IFilterControls, and creates a filter
ReturnsArrayCollection —
|
| getFilterControls | () | method |
public function getFilterControls():ArrayCollectionReturns all the filter controls
ReturnsArrayCollection —
|
| getFilterValue | () | method |
public function getFilterValue(column:String):*Used to set the initial value of the filter.
Parameters
column:String |
* |
| getNextFocusableFilter | () | method |
public function getNextFocusableFilter(myIndex:int, forward:Boolean, inclusive:Boolean = false):IFocusManagerComponentGets the next focusable filter control starting at myIndex, proceeding in forward or backward direction based on the forward parameter
Parameters
myIndex:int — The index to start searching at
| |
forward:Boolean — Direction to search in.
| |
inclusive:Boolean (default = false) |
IFocusManagerComponent — A IFocusManagerComponent that can accept focus.
|
| hasField | () | method |
public function hasField(column:String):BooleanReturns true if the container has a filter control that is bound to the specified column.
Parameters
column:String |
Boolean |
| processFilter | () | method |
public function processFilter():voidIn client mode, applies all the filters
| registerIDataBoundControl | () | method |
public function registerIDataBoundControl(iDataBoundControl:IDataBoundControl):voidRegisters the IDataBoundControl control in our list.
Parameters
iDataBoundControl:IDataBoundControl — A control that implements IDataBoundControl
|
| registerIFilterControl | () | method |
public function registerIFilterControl(iFilterControl:IFilterControl):voidRegisters the IFilter control in our list.
Parameters
iFilterControl:IFilterControl — A control that implements IFilterControl
|
| setFilterFocus | () | method |
public function setFilterFocus(fld:String):Boolean
Parameters
fld:String — The string to match the searchField property of the filter control with.
|
Boolean — True if focus was set, false if otherwise.
Focus may not be set if the given search field does not exist,
or if the filter control for the given search field does not
implement IFocusManagerComponent.
|
| setFilterValue | () | method |
public function setFilterValue(column:String, value:Object):voidUsed to set the initial value of the filter.
Parameters
column:String — The column to set filter for
| |
value:Object — The value to set
|
| setFocusOnNextFocusableControl | () | method |
public function setFocusOnNextFocusableControl(myIndex:int, forward:Boolean, inclusive:Boolean = false):BooleanSets the focus on the next focusable filter control starting at myIndex, proceeding in forward or backward direction based on the forward parameter
Parameters
myIndex:int — The index to start searching at
| |
forward:Boolean — Direction to search in.
| |
inclusive:Boolean (default = false) |
Boolean — A IFocusManagerComponent that can accept focus.
|
| unRegisterIFilterControl | () | method |
public function unRegisterIFilterControl(iFilterControl:IFilterControl):voidRegisters the IFilter control in our list.
Parameters
iFilterControl:IFilterControl — A control that implements IFilterControl
|
| filterChange | Event |