| Package | com.adobe.icc.vo |
| Class | public class Statement |
| Inheritance | Statement  Object |
| Implements | IEventDispatcher |
| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Statements should use the format ({attributeName} {operator} {attributeValue}).
Example 1: To specify (state = 1), set:
- attributeName = "state"
- operator = OP_EQUALS
- attributeValue = 1
To specify that "name" begins with "abc", that is, name = "abc*", set:
- attributeName = "name"
- operator = OP_STARTS_WITH
- attributeValue = "abc"
You can also chain statements together using the innerStatement and joinOperator properties. This allows you to build
compound statements.
Example 2: Consider the statement ((name = "abc*") OR name = "*xyz"). That is, either "name" begins with "abc" or ends with "xyz". To specify this statement, set:
- attributeName = "name"
- operator = OP_STARTS_WITH
- attributeValue = "abc"
Then make a new Statement object and set:
- attributeName = "name"
- operator = OP_ENDS_WITH
- attributeValue = "xyz"
Finally, set the xyz statement as the innerStatement of the abc statement and for the abc statement set joinOperator to JOIN_OR.
Example 3: Searching for modules that either use any data dictionary or use a specific data dictionary.
In this case, take advantage of the fact that statements can search on nested properties. The path to the property is the same as the one which you would
normally use to get at the property on the corresponding value object. If a DataModule object does not use a data dictionary, its
dataDictionaryRefs property is null. However, if it uses one, its DataDictionaryRefs property is set to the
identifier of the data dictionary used by the module.
Therefore, the first statement checks for a null dataDictionaryRefs property and the second, nested statement checks for an existing
dataDictionaryRefs property that is set to a given data dictionary identifier string. Note that the server takes care of looking at the first item within
the dataDictionaryRefs list, even if there are no items:
- attributeName = "dataDictionaryRefs"
- operator = OP_IS_NULL
- attributeValue = null
- joinOperator = JOIN_OR
-
innerStatement =
- attributeName = "dataDictionaryRefs"
- operator = OP_EQUALS
- attributeValue = {dataDictionaryId}
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
| attributeName : String
Specifies the name of the attribute for the statement. | Statement | ||
| attributeValue : Object
Specifies the value for the statement. | Statement | ||
 | constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| innerStatement : Statement
Specifies the inner statement for this statement. | Statement | ||
| joinOperator : String
Specifies the inner statement join operator. | Statement | ||
| operator : String
Specifies the operator for this statement. | Statement | ||
| Method | Defined By | ||
|---|---|---|---|
Constructs a new Statement object, given optional parameters to a simple statement, for convenience. | Statement | ||
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, weakRef:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener
receives notification of an event. | Statement | ||
Dispatches an event into the event flow. | Statement | ||
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | Statement | ||
|
Indicates whether an object has a specified property defined. | Object | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
Removes a listener from the EventDispatcher object. | Statement | ||
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
Returns the string representation of the specified object. | Object | |
|
Returns the primitive value of the specified object. | Object | |
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type. | Statement | ||
| Constant | Defined By | ||
|---|---|---|---|
| JOIN_AND : String = "AND" [static]
Specifies an AND join. | Statement | ||
| JOIN_AND_NOT : String = "AND_NOT" [static]
Specifies an AND NOT join. | Statement | ||
| JOIN_OR : String = "OR" [static]
Specifies an OR join. | Statement | ||
| JOIN_OR_NOT : String = "OR_NOT" [static]
Specifies an OR NOT join. | Statement | ||
| OP_CONTAINS : String = "CONTAINS" [static]
Specifies the contains operator. | Statement | ||
| OP_ENDS_WITH : String = "ENDS_WITH" [static]
Specifies the ends with operator. | Statement | ||
| OP_EQUALS : String = "EQUALS" [static]
Specifies the equals operator. | Statement | ||
| OP_GREATER_EQUALS : String = "GREATER_THAN_EQUALS" [static]
Specifies the greater than or equal to operator. | Statement | ||
| OP_GREATER_THAN : String = "GREATER_THAN" [static]
Specifies the greater than operator. | Statement | ||
| OP_IS_NULL : String = "IS_NULL" [static]
Specifies the null operator. | Statement | ||
| OP_LESS_EQUALS : String = "LESS_THAN_EQUALS" [static]
Specifies the equal to operator. | Statement | ||
| OP_LESS_THAN : String = "LESS_THAN" [static]
Specifies the less than operator. | Statement | ||
| OP_NOT_EQUALS : String = "NOT_EQUALS" [static]
Specifies the not equal operator. | Statement | ||
| OP_STARTS_WITH : String = "STARTS_WITH" [static]
Specifies the starts with operator. | Statement | ||
attributeName | property |
attributeName:String| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Specifies the name of the attribute for the statement. Must be same as the name of the property in the corresponding object type.
This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.
Implementation
public function get attributeName():String public function set attributeName(value:String):voidattributeValue | property |
attributeValue:Object| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Specifies the value for the statement.
This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.
Implementation
public function get attributeValue():Object public function set attributeValue(value:Object):voidinnerStatement | property |
innerStatement:Statement| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Specifies the inner statement for this statement. This property allows you to join two statements using JoinOperator. The statement is then treated as
(this {JoinOperator} innerStatement), where "this" refers to this Statement object and "innerStatement" refers to the innerStatement
property in this object.
WARNING: This property cannot be more than one level deep. Deeper nesting from the top statement is ignored and the server does not throw an exception. Deeper nesting is silently ignored.
This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.
Implementation
public function get innerStatement():Statement public function set innerStatement(value:Statement):voidjoinOperator | property |
joinOperator:String| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Specifies the inner statement join operator. Must be one of the join type constants.
This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.
Implementation
public function get joinOperator():String public function set joinOperator(value:String):voidoperator | property |
operator:String| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Specifies the operator for this statement. Must be one of the operator constants.
This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.
Implementation
public function get operator():String public function set operator(value:String):voidStatement | () | Constructor |
public function Statement(attribute:String = null, operator:String = null, value:Object = null)| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Constructs a new Statement object, given optional parameters to a simple statement, for convenience.
attribute:String (default = null) | |
operator:String (default = null) | |
value:Object (default = null) |
addEventListener | () | method |
public function addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, weakRef:Boolean = false):voidRegisters an event listener object with an EventDispatcher object so that the listener receives notification of an event. You can register event listeners on all nodes in the display list for a specific type of event, phase, and priority.
After you successfully register an event listener, you cannot change its priority
through additional calls to addEventListener(). To change a listener's priority, you
must first call removeEventListener(). Then you can register the listener again with the new
priority level.
After the listener is registered, subsequent calls to
addEventListener() with a different value for either type or useCapture result in the
creation of a separate listener registration. For example, if you first register a
listener with useCapture set to true, it listens only during the capture phase. If you
call addEventListener() again using the same listener object, but with useCapture set to
false, you have two separate listeners: one that listens during the capture phase, and
another that listens during the target and bubbling phases.
You cannot register an event listener for only the target phase or the bubbling phase. Those phases are coupled during registration because bubbling applies only to the ancestors of the target node.
When you no longer need an event listener, remove it by calling EventDispatcher.removeEventListener(); otherwise, memory problems might result. Objects
with registered event listeners are not automatically removed from memory because the
garbage collector does not remove objects that still have references.
Copying an EventDispatcher instance does not copy the event listeners attached to it. (If your newly created node needs an event listener, you must attach the listener after creating the node.) However, if you move an EventDispatcher instance, the event listeners attached to it move along with it.
If the event listener is being registered on a node while an event is also being processed on this node, the event listener is not triggered during the current phase but may be triggered during a later phase in the event flow, such as the bubbling phase.
If an event listener is removed from a node while an event is being processed on the node, it is still triggered by the current actions. After it is removed, the event listener is never invoked again (unless it is registered again for future processing).
Parameters
type:String — The type of event.
| |
listener:Function — The listener function that processes the event. This function must accept an event object
as its only parameter and must return nothing, as this example shows:
| |
useCapture:Boolean (default = false)useCapture is set to true, the
listener processes the event only during the capture phase and not in the target or
bubbling phase. If useCapture is false, the listener processes the event only
during the target or bubbling phase. To listen for the event in all three phases, call
addEventListener() twice, once with useCapture set to true,
then again with useCapture set to false.
| |
priority:int (default = 0) | |
weakRef:Boolean (default = false)Class-level member functions are not subject to garbage
collection, so you can set |
dispatchEvent | () | method |
public function dispatchEvent(event:Event):Boolean
Dispatches an event into the event flow. The event target is the
EventDispatcher object upon which dispatchEvent() is called.
Parameters
event:Event — The event object dispatched into the event flow.
|
Boolean — A value of true unless preventDefault() is called on the event,
in which case it returns false.
|
hasEventListener | () | method |
public function hasEventListener(type:String):Boolean
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. This allows you to determine where an EventDispatcher object has altered handling of an event type in the event flow hierarchy. To determine whether
a specific event type will actually trigger an event listener, use IEventDispatcher.willTrigger().
The difference between hasEventListener() and willTrigger() is that hasEventListener() examines only the object to which it belongs, whereas willTrigger() examines the entire event flow for the event specified by the type parameter.
Parameters
type:String — The type of event.
|
Boolean — A value of true if a listener of the specified type is registered; false otherwise.
|
removeEventListener | () | method |
public function removeEventListener(type:String, listener:Function, useCapture:Boolean = false):voidRemoves a listener from the EventDispatcher object. If there is no matching listener registered with the EventDispatcher object, a call to this method has no effect.
Parameters
type:String — The type of event.
| |
listener:Function — The listener object to remove.
| |
useCapture:Boolean (default = false)removeEventListener() are required to remove both: one call with useCapture set to true, and another call with useCapture set to false.
|
willTrigger | () | method |
public function willTrigger(type:String):Boolean
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type. This method returns true if an event listener is triggered during any phase of the event flow when an event of the specified type is dispatched to this EventDispatcher object or any of its descendants.
The difference between hasEventListener() and willTrigger() is that hasEventListener() examines only the object to which it belongs, whereas willTrigger() examines the entire event flow for the event specified by the type parameter.
Parameters
type:String — The type of event.
|
Boolean — A value of true if a listener of the specified type will be triggered; false otherwise.
|
JOIN_AND | Constant |
public static const JOIN_AND:String = "AND"| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Specifies an AND join.
JOIN_AND_NOT | Constant |
public static const JOIN_AND_NOT:String = "AND_NOT"| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Specifies an AND NOT join.
JOIN_OR | Constant |
public static const JOIN_OR:String = "OR"| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Specifies an OR join.
JOIN_OR_NOT | Constant |
public static const JOIN_OR_NOT:String = "OR_NOT"| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Specifies an OR NOT join.
OP_CONTAINS | Constant |
public static const OP_CONTAINS:String = "CONTAINS"| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Specifies the contains operator.
OP_ENDS_WITH | Constant |
public static const OP_ENDS_WITH:String = "ENDS_WITH"| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Specifies the ends with operator.
OP_EQUALS | Constant |
public static const OP_EQUALS:String = "EQUALS"| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Specifies the equals operator. That is, "=".
OP_GREATER_EQUALS | Constant |
public static const OP_GREATER_EQUALS:String = "GREATER_THAN_EQUALS"| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Specifies the greater than or equal to operator.
OP_GREATER_THAN | Constant |
public static const OP_GREATER_THAN:String = "GREATER_THAN"| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Specifies the greater than operator.
OP_IS_NULL | Constant |
public static const OP_IS_NULL:String = "IS_NULL"| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Specifies the null operator.
OP_LESS_EQUALS | Constant |
public static const OP_LESS_EQUALS:String = "LESS_THAN_EQUALS"| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Specifies the equal to operator.
OP_LESS_THAN | Constant |
public static const OP_LESS_THAN:String = "LESS_THAN"| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Specifies the less than operator.
OP_NOT_EQUALS | Constant |
public static const OP_NOT_EQUALS:String = "NOT_EQUALS"| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Specifies the not equal operator.
OP_STARTS_WITH | Constant |
public static const OP_STARTS_WITH:String = "STARTS_WITH"| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Specifies the starts with operator.
Wed Nov 21 2018, 06:34 AM -08:00