Packagecom.gestureworks.cml.elements
Classpublic class FlickrQuery
InheritanceFlickrQuery Inheritance TouchContainer Inheritance com.gestureworks.core.TouchSprite

The FlickQuery is designed to be used with the dock to set a query in CML that may be used in conjunction with searchFields and the dials to provide a way to search via groups, users, and tags.
     
       
     
     

See also

YouTube


Public Properties
 PropertyDefined By
  apikey : String
The user's API key, necessary for making queries to the API, but not necessary for single images.
FlickrQuery
 InheritedautoShuffle : Boolean
autoshuffles
TouchContainer
 InheritedchildList : ChildList
Returns the object's childList.
TouchContainer
 InheritedclassName : String
sets the class name of displayobject
TouchContainer
 InheritedcloneExclusions : Vector.<String>
[read-only] Returns a list of properties to exclude when cloning this object
TouchContainer
 InheritedcmlIndex : int
Returns the index created by the CML parser.
TouchContainer
  data : Object
[read-only]
FlickrQuery
 InheriteddimensionsTo : Object
Sets the dimensions of TouchContainer to given object
TouchContainer
 InheriteddropShadow : Boolean
Sets the drop shadow effect
TouchContainer
 Inheritedgroup : String
TouchContainer
  groupid : String
Groupid is currently not supported by the Actionscript version of the Flickr API.
FlickrQuery
 Inheritedheight : Number
[override] sets the height of the container
TouchContainer
 InheritedheightPercent : Number
sets the height of the container
TouchContainer
 Inheritedid : String
Returns the object's id.
TouchContainer
  isCommons : Boolean
Return images that are part of the Flickr commons project.
FlickrQuery
 Inheritedlayout : *
specifies the type of layout
TouchContainer
 InheritedlayoutList : Dictionary
TouchContainer
  loaded : String
[read-only] Read-only property indicating if the element is loaded or not.
FlickrQuery
 InheritedmouseChildren : Boolean
[override] sets the mousechildren value to true or false.
TouchContainer
 InheritedpaddingBottom : Number
Sets the number of pixels between the container's bottom border and the bottom of its content area.
TouchContainer
 InheritedpaddingLeft : Number
Sets the number of pixels between the component's left border and the left edge of its content area.
TouchContainer
 InheritedpaddingRight : Number
Sets the number of pixels between the component's right border and the right edge of its content area.
TouchContainer
 InheritedpaddingTop : Number
Sets the number of pixels between the container's top border and the top of its content area.
TouchContainer
  pageNumber : int = 1
FlickrQuery
  pages : Number
[read-only] Read-only property indicating number of page results returned.
FlickrQuery
  photosetid : String
Photoset id is used to return every photo in a photoset.
FlickrQuery
 Inheritedposition : *
Sets the position
TouchContainer
 InheritedrelativeX : Boolean
When set true this containers children's x position will be laid out relatively to each other.
TouchContainer
 InheritedrelativeY : Boolean
When set true this containers children's y position will be laid out relatively to each other.
TouchContainer
  resultPhotos : Array
FlickrQuery
  results : Number
[read-only] Read-only property indicating total results per page returned.
FlickrQuery
  resultsPerPage : int
Select the number of results to turn per page.
FlickrQuery
  setDescription : String
[read-only] Read only property that returns the description of a set after set info is returned.
FlickrQuery
 Inheritedsound : String
TouchContainer
 Inheritedstate : Dictionary
TouchContainer
 InheritedstateId : *
Returns the current state id.
TouchContainer
  tagMode : String
Either "any" for an OR combination of tags, or "all" for an AND combination.
FlickrQuery
  tags : String
A comma separated list of tags to search for.
FlickrQuery
  text : String
An optional string to search for, this will search titles, descriptions, and tags.
FlickrQuery
 InheritedtoBitmap : Boolean
TouchContainer
  total : int
[read-only] Read-only property to get the total number of results available to a search (regardless of per page limitations)
FlickrQuery
  userid : String
FlickrQuery
 Inheritedwidth : Number
[override] sets the width of the container
TouchContainer
 InheritedwidthPercent : Number
sets the width of the container
TouchContainer
Protected Properties
 PropertyDefined By
 InheritedcmlGestureList : Object
TouchContainer
Public Methods
 MethodDefined By
  
Constructor
FlickrQuery
 Inherited
TouchContainer
 Inherited
method searches the child and adds to the list
TouchContainer
 Inherited
addChild(child:DisplayObject):DisplayObject
[override] Adds child to display list and, if not already added, the child list
TouchContainer
 Inherited
addChildAt(child:DisplayObject, index:int):DisplayObject
[override] Adds child to display list and, if not already added, the child list
TouchContainer
 Inherited
applyLayout(value:* = null):void
Apply the containers layout
TouchContainer
 Inherited
childToList(id:String, child:*):void
child appended to the childlist
TouchContainer
 Inherited
clone():*
Clone method
TouchContainer
  
dispose():void
[override] Destructor
FlickrQuery
  
FlickrQuery
  
flickrSet():void
FlickrQuery
  
FlickrQuery
 Inherited
getElementById(id:String):*
Searches CML childList by id.
TouchContainer
 Inherited
getElementsByClassName(className:String):Array
Searches the CML childList by className.
TouchContainer
 Inherited
getElementsByTagName(tagName:Class):Array
Searches the CML childList by tagName as Class.
TouchContainer
  
init():void
[override] Initialisation method
FlickrQuery
 Inherited
loadState(sId:* = null, recursion:Boolean = false):void
Loads state by index number.
TouchContainer
 Inherited
makeGestureList(value:XMLList):Object
Creates gestureList object from XML
TouchContainer
  
nextPage():void
FlickrQuery
 Inherited
parseCML(cml:XMLList):XMLList
Parse cml for local layouts.
TouchContainer
 Inherited
postparseCML(cml:XMLList):void
Abstract method allows the setting of a postparse CML routine.
TouchContainer
  
FlickrQuery
 Inherited
querySelector(selector:String):*
Searches the CML childList by selector.
TouchContainer
 Inherited
querySelectorAll(selector:*):Array
Search the CML childList by selector.
TouchContainer
 Inherited
removeChild(child:DisplayObject):DisplayObject
[override] Removes child from display list and, if not already removed, the child list
TouchContainer
 Inherited
removeChildAt(index:int):DisplayObject
[override] Removes child from display list and, if not already removed, the child list
TouchContainer
 Inherited
removeChildren(beginIndex:int = 0, endIndex:int = 2147483647):void
[override] Removes children from display list and, if not already removed, the child list
TouchContainer
 Inherited
saveState(sId:* = null, recursion:Boolean = false):void
Save state by index number.
TouchContainer
 Inherited
searchChildren(value:*, returnType:Class = null):*
This method does a depth first search of childLists.
TouchContainer
 Inherited
method sets the dimensions of each child
TouchContainer
 Inherited
tweenState(sId:* = null, tweenTime:Number = 1):void
Tween state by stateIndex from current to given state index.
TouchContainer
 Inherited
Updates child padding within this container
TouchContainer
 Inherited
Updates child percent dimensions within this container
TouchContainer
 Inherited
updateProperties(state:* = 0):void
Updates properties from state.
TouchContainer
 Inherited
Updates child relative positions within this container
TouchContainer
Property Detail
apikeyproperty
apikey:String

The user's API key, necessary for making queries to the API, but not necessary for single images.


Implementation
    public function get apikey():String
    public function set apikey(value:String):void
dataproperty 
data:Object  [read-only]


Implementation
    public function get data():Object
groupidproperty 
groupid:String

Groupid is currently not supported by the Actionscript version of the Flickr API.


Implementation
    public function get groupid():String
    public function set groupid(value:String):void
isCommonsproperty 
isCommons:Boolean

Return images that are part of the Flickr commons project.


Implementation
    public function get isCommons():Boolean
    public function set isCommons(value:Boolean):void
loadedproperty 
loaded:String  [read-only]

Read-only property indicating if the element is loaded or not.


Implementation
    public function get loaded():String
pageNumberproperty 
public var pageNumber:int = 1

pagesproperty 
pages:Number  [read-only]

Read-only property indicating number of page results returned.


Implementation
    public function get pages():Number
photosetidproperty 
photosetid:String

Photoset id is used to return every photo in a photoset. This does not run on search, it needs to be used with the flickrSet() method to retrieve results.


Implementation
    public function get photosetid():String
    public function set photosetid(value:String):void
resultPhotosproperty 
public var resultPhotos:Array

resultsproperty 
results:Number  [read-only]

Read-only property indicating total results per page returned.


Implementation
    public function get results():Number
resultsPerPageproperty 
resultsPerPage:int

Select the number of results to turn per page.

The default value is 12.


Implementation
    public function get resultsPerPage():int
    public function set resultsPerPage(value:int):void
setDescriptionproperty 
setDescription:String  [read-only]

Read only property that returns the description of a set after set info is returned.


Implementation
    public function get setDescription():String
tagModeproperty 
tagMode:String

Either "any" for an OR combination of tags, or "all" for an AND combination.

The default value is "all".


Implementation
    public function get tagMode():String
    public function set tagMode(value:String):void
tagsproperty 
tags:String

A comma separated list of tags to search for.


Implementation
    public function get tags():String
    public function set tags(value:String):void
textproperty 
text:String

An optional string to search for, this will search titles, descriptions, and tags.


Implementation
    public function get text():String
    public function set text(value:String):void
totalproperty 
total:int  [read-only]

Read-only property to get the total number of results available to a search (regardless of per page limitations)


Implementation
    public function get total():int
useridproperty 
userid:String


Implementation
    public function get userid():String
    public function set userid(value:String):void
Constructor Detail
FlickrQuery()Constructor
public function FlickrQuery()

Constructor

Method Detail
dispose()method
override public function dispose():void

Destructor

flickrSearch()method 
public function flickrSearch():void

flickrSet()method 
public function flickrSet():void

flickrSetInfo()method 
public function flickrSetInfo():void

init()method 
override public function init():void

Initialisation method

nextPage()method 
public function nextPage():void

previousPage()method 
public function previousPage():void