Packagecom.afcomponents.umap.interfaces
Interfacepublic interface IMapObjectContainer extends IMapObject, flash.events.IEventDispatcher
SubinterfacesIManager
ImplementorsControl, Display, Layer, MapObjectContainer

IMapObjectConatiner is the base interface for the container objects used in the UMap.


Public Properties
 PropertyDefined by
 InheritedasDisplayObject : DisplayObject
Returns reference to the object as a DisplayObject instance.
IMapObject
 Inheritedcore : UMap
Returns reference to the core UMap object.
IMapObject
 Inheritedid : uint
Gets or sets the ID of the object.
IMapObject
 Inheritedname : String
Gets or sets the name of the object.
IMapObject
 Inheritedowner : IMapObjectContainer
Returns reference to the owner container object.
IMapObject
Public Methods
 MethodDefined by
  
addObject(object:IMapObject):void
Adds new IMapObject to the container.
IMapObjectContainer
  
bringForward(object:IMapObject):void
Moves the attached IMapObject forward in the display list.
IMapObjectContainer
  
bringToFront(object:IMapObject):void
Brings the attached IMapObject to the top of the display list.
IMapObjectContainer
  
clearObjects(filter:Class = null):void
Removes all attached objects.
IMapObjectContainer
 Inherited
dispose():void
Releases all the resources accuired by the object.
IMapObject
  
getObject(id_or_name:*, filter:Class = null):IMapObject
Searches for an object with specified id or name.
IMapObjectContainer
  
getObjectById(id:uint, filter:Class = null):IMapObject
Searches for an object with specified id.
IMapObjectContainer
  
getObjectByName(name:String, matchCase:Boolean = false, filter:Class = null):IMapObject
Searches for an object with specified name.
IMapObjectContainer
  
getObjects(filter:Class = null):Array
Returns an array of IMapObjects that where added to the container.
IMapObjectContainer
  
isOwnerVisible():Boolean
Recursevly checks visibility of parent objects
IMapObjectContainer
 Inherited
remove():void
Removes the object from the owner container object.
IMapObject
  
removeObject(object:IMapObject):void
Removes IMapObject from the container.
IMapObjectContainer
  
sendBackward(object:IMapObject):void
Sends the attached IMapObject backward in the display list.
IMapObjectContainer
  
sendToBack(object:IMapObject):void
Sends the attached IMapObject to the bottom of the display list.
IMapObjectContainer
 Inherited
setOwner(owner:IMapObjectContainer):void
Adds the object to the specified IMapObjectContainer.
IMapObject
 Inherited
toString():String
Returns a textual representation of the object.
IMapObject
Method detail
addObject()method
public function addObject(object:IMapObject):void

Adds new IMapObject to the container.

Parameters
object:IMapObject — Reference to an object that should be added to the container.
bringForward()method 
public function bringForward(object:IMapObject):void

Moves the attached IMapObject forward in the display list.

Parameters
object:IMapObject — Reference to IMapObject that should be moved forward.
bringToFront()method 
public function bringToFront(object:IMapObject):void

Brings the attached IMapObject to the top of the display list.

Parameters
object:IMapObject — Reference to IMapObject that should be brought to front.
clearObjects()method 
public function clearObjects(filter:Class = null):void

Removes all attached objects. If filter parameter is defined, only removes objects of the specified class.

Parameters
filter:Class (default = null) — Class that should be used as a filter.
getObject()method 
public function getObject(id_or_name:*, filter:Class = null):IMapObject

Searches for an object with specified id or name. Additionally you can filter objects by it's type. For speed, please consider using getObjectById(), and getObjectByName() methods.

Parameters
id_or_name:* — ID or name of the object. If you pass a Number object will be searched by it's ID. If you pass a String object will be searched by it's name and the letter case will not match.
 
filter:Class (default = null) — Class that should be used as a filter.

Returns
IMapObject — Reference to the found object or null if it was not found.

See also

getObjectById()
getObjectByName()
getObjectById()method 
public function getObjectById(id:uint, filter:Class = null):IMapObject

Searches for an object with specified id. Additionally you can filter objects by it's type.

Parameters
id:uint — ID of the object.
 
filter:Class (default = null) — Class that should be used as a filter.

Returns
IMapObject — Reference to the found object or null if it was not found.
getObjectByName()method 
public function getObjectByName(name:String, matchCase:Boolean = false, filter:Class = null):IMapObject

Searches for an object with specified name. Additionally you can specify whether to match case when searching and you can also filter objects by it's type.

Parameters
name:String — Name of the object.
 
matchCase:Boolean (default = false) — Defines whether to match case when searching.
 
filter:Class (default = null) — Class that should be used as a filter.

Returns
IMapObject — Reference to the found object or null if it was not found.
getObjects()method 
public function getObjects(filter:Class = null):Array

Returns an array of IMapObjects that where added to the container. Additionally you can specify a class name to return only the objects of that class.

Parameters
filter:Class (default = null) — Name of the class that should be used as a filter.

Returns
Array — An Array holding all the attached objects.
isOwnerVisible()method 
public function isOwnerVisible():Boolean

Recursevly checks visibility of parent objects

Returns
Boolean
removeObject()method 
public function removeObject(object:IMapObject):void

Removes IMapObject from the container.

Parameters
object:IMapObject — Reference to an object that should be removed from the container.
sendBackward()method 
public function sendBackward(object:IMapObject):void

Sends the attached IMapObject backward in the display list.

Parameters
object:IMapObject — Reference to IMapObject that should be sent backward.
sendToBack()method 
public function sendToBack(object:IMapObject):void

Sends the attached IMapObject to the bottom of the display list.

Parameters
object:IMapObject — Reference to IMapObject that should be sent to back.



© 2007-2008 advanced flash components