Packagecom.adobe.bridge
Classpublic class FilterDescription
InheritanceFilterDescription Inheritance CSHostObject Inheritance flash.utils.Proxy

Since : CS5

Filters are applied to children of a container node when Adobe Bridge needs to display that container's contents in the Content pane, or display a list of children in a menu. A filter description identifies a metadata property (from embedded XMP metadata) or a node property (from a node-handler-defined Infoset Object) to display in the Filter palette. The Filter palette displays each filter property, with a line under each property for each value it finds for that property in any child node. The filter description can provide a narrower list of allowed values to display for an XMP property, if the property has a closed value list.When the user selects a filter, a child node is displayed only if it contains the selected filter property and value.The list of filter objects that Adobe Bridge uses by default to populate the Filter palette is kept in app.defaultFilterCriteria. When displaying a handled container node, Adobe Bridge builds the list of filters by calling the developer-defined getFilterCriteria() method of the node's ExtensionModel object. Your implementation of this method can create these filter objects, and use them to replace, modify, or add to the default list.



Public Properties
 PropertyDefined By
  closedValueList : Array
The set of allowed values for the XMP property, if it has a closed value list.
FilterDescription
  displayName : String
A localized name for this filter, shown in the heading line for this filter in the Filter pane.
FilterDescription
  filterType : String
The data type of filter-property value, used in sorting the list of values.
FilterDescription
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  infosetMember : String
The name of the node property to use as a filter, as defined in the InfosetMemberDescription object.
FilterDescription
  isExclusive : Boolean
When true, only one of the filter values can be set at a time.
FilterDescription
  name : String
The unique identifying name of the filter.
FilterDescription
  xmpNamespace : String
The namespace of the XMP property used as a filter.
FilterDescription
  xmpProperty : String
The key name of the XMP property used as a filter.
FilterDescription
Public Methods
 MethodDefined By
  
FilterDescription(name:String = null, displayName:String = null, filterType:String = null, arg4:Object = null, arg5:Object = null, arg6:Object = null, arg7:Object = null)
FilterDescription
 Inherited
filterArgsForHBAPI(args:Array):Array
[static] Function to clean up the argument list and put it into a format that makes sense for HBAPI.
CSHostObject
 Inherited
filterSingleObjectForHBAPI(value:Object):Object
[static]
CSHostObject
 Inherited
getClassObjectForName(className:String):HostObject
[static] This returns a "Class" object, meaning, a HostObject that can be used to make static function calls or get static properties
CSHostObject
 Inherited
getSpecialTranslation(className:String, ho:HostObject, expectedReturnType:Class, ownerName:String):*
[static]
CSHostObject
 Inherited
hostCall(name:String, expectedReturnType:Class, rawargs:Array):*
Encapsulates a function call to the host
CSHostObject
 Inherited
hostCallStatic(className:String, methodName:String, expectedReturnType:Class, rawargs:Array):*
[static] Implements a safe call of a static method on the host
CSHostObject
 Inherited
hostGet(name:String, expectedReturnType:Class):*
Encapsulates a property get to the host
CSHostObject
 Inherited
hostGetIndex(idx:Object, expectedReturnType:Class):*
Encapsulates a indexed get to the host
CSHostObject
 Inherited
hostGetStatic(className:String, propertyName:String, expectedReturnType:Class):*
[static] Implements a safe get of a static property on the host Used by for instance, all the enum implementations.
CSHostObject
 Inherited
hostSet(name:String, rawvalue:*):void
Encapsulates a property set to the host
CSHostObject
 Inherited
hostSetStatic(className:String, propertyName:String, rawvalue:*):*
[static] Implements a safe set of a static property on the host
CSHostObject
 Inherited
isDescendedFrom(clz:Class, ancClass:Class):Boolean
[static] Efficiently determines whether or not one class descends from another in inheritance hierarchy- class relationships are cached by the ClassUtils implementation- (uses org.as3commons lib to quickly discover class hierarchy.
CSHostObject
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
 Inherited
wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):*
[static] Method used on static/normal get/ hostcalls
CSHostObject
Protected Methods
 MethodDefined By
  
createWithArgs(args:Array):void
[override]
FilterDescription
 Inherited
hostCreate(args:Array):void
CSHostObject
Property Detail
closedValueListproperty
closedValueList:Array

Since : CS5

The set of allowed values for the XMP property, if it has a closed value list.


Implementation
    public function get closedValueList():Array
    public function set closedValueList(value:Array):void
displayNameproperty 
displayName:String

Since : CS5

A localized name for this filter, shown in the heading line for this filter in the Filter pane.


Implementation
    public function get displayName():String
    public function set displayName(value:String):void
filterTypeproperty 
filterType:String

Since : CS5

The data type of filter-property value, used in sorting the list of values.


Implementation
    public function get filterType():String
    public function set filterType(value:String):void
infosetMemberproperty 
infosetMember:String

Since : CS5

The name of the node property to use as a filter, as defined in the InfosetMemberDescription object.


Implementation
    public function get infosetMember():String
    public function set infosetMember(value:String):void
isExclusiveproperty 
isExclusive:Boolean

Since : CS5

When true, only one of the filter values can be set at a time.


Implementation
    public function get isExclusive():Boolean
    public function set isExclusive(value:Boolean):void
nameproperty 
name:String

Since : CS5

The unique identifying name of the filter.


Implementation
    public function get name():String
    public function set name(value:String):void
xmpNamespaceproperty 
xmpNamespace:String

Since : CS5

The namespace of the XMP property used as a filter.


Implementation
    public function get xmpNamespace():String
    public function set xmpNamespace(value:String):void
xmpPropertyproperty 
xmpProperty:String

Since : CS5

The key name of the XMP property used as a filter.


Implementation
    public function get xmpProperty():String
    public function set xmpProperty(value:String):void
Constructor Detail
FilterDescription()Constructor
public function FilterDescription(name:String = null, displayName:String = null, filterType:String = null, arg4:Object = null, arg5:Object = null, arg6:Object = null, arg7:Object = null)

Since : CS5

Parameters
name:String (default = null) — (String)
 
displayName:String (default = null) — (String)
 
filterType:String (default = null) — (String)
 
arg4:Object (default = null) — (Object)
 
arg5:Object (default = null) — (Object)
 
arg6:Object (default = null) — (Object)
 
arg7:Object (default = null) — (Object)
Method Detail
createWithArgs()method
override protected function createWithArgs(args:Array):void

Since : CS5

Parameters

args:Array