Packagecom.afcomponents.umap.display.infowindow
Classpublic class Panel
InheritancePanel Inheritance flash.display.Sprite
ImplementsIPanel
SubclassesAssetPanel, ImagePanel, TextPanel

Panel is an abstract IPanel implemetation. Use it as a base class for your custom panels.

See also

com.afcomponents.umap.interfaces.IPanel


Public Properties
 PropertyDefined by
  asDisplayObject : DisplayObject
[read-only] Returns a reference to the Panel as a DisplayObject.
Panel
Protected Properties
 PropertyDefined by
  _autoSize : String
Auto size type.
Panel
  _data : *
Panel data.
Panel
  _maxSize : Size
Maximum possible size.
Panel
  _size : Size
Desired size.
Panel
Public Methods
 MethodDefined by
  
Panel(name:String = null)
Panel's constructor.
Panel
  
close():void
Invoked by info window when it has been closed.
Panel
  
dispose():void
Invoked by Info Window to tell the panel auto size type and maximum size.
Panel
  
getData():*
Returns panel data.
Panel
  
Returns actual size of the Panel.
Panel
  
Returns the style object associated with the panel.
Panel
  
init(data:*, maxSize:Size, autoSizeType:String, style:Object = null):void
Initalizes the panel options.
Panel
  
move(x:Number, y:Number):void
Moves panel to the specified point.
Panel
  
reset():void
Refreshes the panel.
Panel
  
resize():void
Invoked when the size of the panel should be updated.
Panel
  
setData(value:*):void
Sets new panel data.
Panel
  
setFinalSize(size:Size):void
Invoked by InfoWindow to inform the Panel about the final available size for the panel.
Panel
  
setSize(size:Size, maxSize:Size = null):void
Invoked by InfoWindow to inform the Panel about the desired size.
Panel
  
setStyle(style:Object):void
Sets the style of the panel.
Panel
Property detail
asDisplayObjectproperty
asDisplayObject:DisplayObject  [read-only]

Returns a reference to the Panel as a DisplayObject.

Implementation
    public function get asDisplayObject():DisplayObject
_autoSizeproperty 
protected var _autoSize:String

Auto size type.

See also

_dataproperty 
protected var _data:*

Panel data.

_maxSizeproperty 
protected var _maxSize:Size

Maximum possible size.

_sizeproperty 
protected var _size:Size

Desired size.

Constructor detail
Panel()constructor
public function Panel(name:String = null)

Panel's constructor.

Parameters
name:String (default = null)
Method detail
close()method
public function close():void

Invoked by info window when it has been closed.

dispose()method 
public function dispose():void

Invoked by Info Window to tell the panel auto size type and maximum size.

getData()method 
public function getData():*

Returns panel data.

Returns
*
getSize()method 
public function getSize():Size

Returns actual size of the Panel.

Returns
Size
getStyle()method 
public function getStyle():Style

Returns the style object associated with the panel.

Returns
Style
init()method 
public function init(data:*, maxSize:Size, autoSizeType:String, style:Object = null):void

Initalizes the panel options.

Parameters
data:* — Panel data.
 
maxSize:Size — Maximum panel size.
 
autoSizeType:String — Automatic size type.
 
style:Object (default = null) — Additional style object.
move()method 
public function move(x:Number, y:Number):void

Moves panel to the specified point.

Parameters
x:Number — Target x coordinate.
 
y:Number — Target y coordinate.
reset()method 
public function reset():void

Refreshes the panel.

resize()method 
public function resize():void

Invoked when the size of the panel should be updated.

setData()method 
public function setData(value:*):void

Sets new panel data.

Parameters
value:*
setFinalSize()method 
public function setFinalSize(size:Size):void

Invoked by InfoWindow to inform the Panel about the final available size for the panel. You can align the content of your panel if it is smaller than this final size.

Parameters
size:Size — Final available dimensions of the panel.
setSize()method 
public function setSize(size:Size, maxSize:Size = null):void

Invoked by InfoWindow to inform the Panel about the desired size. Optionally you can redefine max size in the same call.

Parameters
size:Size — Desired dimensions of the panel.
 
maxSize:Size (default = null) — Maximum dimensions of the panel.
setStyle()method 
public function setStyle(style:Object):void

Sets the style of the panel. It can be a Style type, or an object.

Parameters
style:Object — Object that contains some or all of the style properties.