Packageat.display
Classpublic class SlideItemRenderer
InheritanceSlideItemRenderer Inheritance mx.core.UIComponent
Implementsmx.controls.listClasses.IListItemRenderer, mx.core.IDataRenderer
SubclassesBookmarkSlideItemRenderer, QuickViewSlideItemRenderer, SiteMapSlideItemRenderer

The itemRenderer for the PreCallModule and the QuickViewModule.

Default MXML Propertydata



Public Properties
 PropertyDefined by
  badgeLabel : int = 0
The number that is displayed on the badge.
SlideItemRenderer
  circle : PreCallCircle
The circle that displays a plus or a number for the renderer.
SlideItemRenderer
  color : uint = 0x000000
The color of the circle on the image that corresponds to the section of the image in the renderer.
SlideItemRenderer
  data : Object
Implementation of the IDataRenderer data property.
SlideItemRenderer
  drawBackround : Boolean = false
Draws a background the using color to take up the entire size including the padding area.
SlideItemRenderer
  isAddable : Boolean
When set to true, the circle displays a "Plus" to add this slide to the SlideDropTarget.
SlideItemRenderer
  isRemoveable : Boolean
When set to true, the circle displays a "Minus" to indicate it can be removed.
SlideItemRenderer
  num : String = ""
The number in the list that is viewable on the image.
SlideItemRenderer
  showBadge : Boolean = false
Sets the visibility for the badge that depicts the number of slides associated with the current slide.
SlideItemRenderer
  thumbnailField : String
SlideItemRenderer
  thumbnailHeight : int
The height in pixels of the Slide thumbnail.
SlideItemRenderer
  thumbnailWidth : int
The width in pixels of the Slide thumbnail.
SlideItemRenderer
  title : String = ""
Title of the slide.
SlideItemRenderer
  useSlideGroupColor : Boolean = false
When true the color value is passed from the parent to this renderer and that color is used as the circle background color.
SlideItemRenderer
Protected Properties
 PropertyDefined by
  badge : PreCallBadge
The display badge for the number of dependent Slides in the renderer.
SlideItemRenderer
  _slideColor : uint
Holder for the color that the slide brings with it.
SlideItemRenderer
  thumbSource : String = ""
The filename of the thumbnail that is loaded into the renderer.
SlideItemRenderer
  titleLabel : Label
The label for the Slide title in the renderer.
SlideItemRenderer
Public Methods
 MethodDefined by
  
Constructor.
SlideItemRenderer
Protected Methods
 MethodDefined by
  
addSlide(e:MouseEvent):void
Dispatches a PreCallModuleEvent.ADD_SLIDE event if isAddable is true.
SlideItemRenderer
  
reset():void
Reverts the settings to default for use as an itemRenderer.
SlideItemRenderer
Events
 EventSummaryDefined by
   Dispatched when the thumbnail has loaded and is displayed.SlideItemRenderer
Styles
 StyleDescriptionDefined by
  
borderThickness
Type: Number
The desired thickness of the border around the thumbnail. The color of the border will be the color property.

The amount of padding will be the same all the way around the thumbnail. The total thickness of the area around the thumbnail will be padding + borderThickness.

This setting only applies if drawBorder is true.

The default value is 0.
SlideItemRenderer
  
padding
Type: Number
The amount of transparent area in pixels all the way around the thumbnail. The default value is 2.
SlideItemRenderer
  
titleBackgroundAlpha
Type: Number
The alpha of the background for the title. The default value is .6.
SlideItemRenderer
  
titleBackgroundColor
Type: uint   Format: Color
The color of the background for the title. The default value is 0x000000.
SlideItemRenderer
  
titleStyleName
Type: String
The styleName for the title on the slide. The default value is "titleStyle".
SlideItemRenderer
Property detail
badgeproperty
protected var badge:PreCallBadge

The display badge for the number of dependent Slides in the renderer.

badgeLabelproperty 
public var badgeLabel:int = 0

The number that is displayed on the badge.

The default value is 0.

circleproperty 
public var circle:PreCallCircle

The circle that displays a plus or a number for the renderer.

colorproperty 
public var color:uint = 0x000000

The color of the circle on the image that corresponds to the section of the image in the renderer.

The default value is 0x000000;.

dataproperty 
data:Object  [read-write]

Implementation of the IDataRenderer data property.

This property can be used as the source for data binding.

Implementation
    public function get data():Object
    public function set data(value:Object):void
drawBackroundproperty 
public var drawBackround:Boolean = false

Draws a background the using color to take up the entire size including the padding area.

isAddableproperty 
isAddable:Boolean  [read-write]

When set to true, the circle displays a "Plus" to add this slide to the SlideDropTarget. If set to false then num is displayed instead.

The default value is true.

Implementation
    public function get isAddable():Boolean
    public function set isAddable(value:Boolean):void
isRemoveableproperty 
isRemoveable:Boolean  [read-write]

When set to true, the circle displays a "Minus" to indicate it can be removed. Only used with adding bookmarks. If set to false then num is displayed instead.

The default value is false.

Implementation
    public function get isRemoveable():Boolean
    public function set isRemoveable(value:Boolean):void
numproperty 
public var num:String = ""

The number in the list that is viewable on the image.

The default value is "".

showBadgeproperty 
public var showBadge:Boolean = false

Sets the visibility for the badge that depicts the number of slides associated with the current slide. Always set to false when used in a SlideDropTargetItemRenderer. Automatically set to true if there is children in the data passed into the renderer.

The default value is false.

_slideColorproperty 
protected var _slideColor:uint

Holder for the color that the slide brings with it. This color will become the color variable if the useSlideGroupColor is set to false.

The default value is null.

thumbnailFieldproperty 
thumbnailField:String  [read-write]Implementation
    public function get thumbnailField():String
    public function set thumbnailField(value:String):void
thumbnailHeightproperty 
thumbnailHeight:int  [read-write]

The height in pixels of the Slide thumbnail.

The default value is 112.

Implementation
    public function get thumbnailHeight():int
    public function set thumbnailHeight(value:int):void
thumbnailWidthproperty 
thumbnailWidth:int  [read-write]

The width in pixels of the Slide thumbnail.

The default value is 152;.

Implementation
    public function get thumbnailWidth():int
    public function set thumbnailWidth(value:int):void
thumbSourceproperty 
protected var thumbSource:String = ""

The filename of the thumbnail that is loaded into the renderer.

The location is relative to the root of the application. This uses the data passed in via the slideThumbnailFilename or can be changed to load another path by setting the thumbnailField attribute.

The default value is "".

See also

thumbnailField
titleproperty 
public var title:String = ""

Title of the slide.

The default value is "".

titleLabelproperty 
protected var titleLabel:Label

The label for the Slide title in the renderer.

useSlideGroupColorproperty 
public var useSlideGroupColor:Boolean = false

When true the color value is passed from the parent to this renderer and that color is used as the circle background color. If this is set to false the color attribute of the data passed into the control is used instead.

The default value is false.

Constructor detail
SlideItemRenderer()constructor
public function SlideItemRenderer()

Constructor.

Method detail
addSlide()method
protected function addSlide(e:MouseEvent):void

Dispatches a PreCallModuleEvent.ADD_SLIDE event if isAddable is true.

Parameters
e:MouseEvent — The mouse click event
reset()method 
protected function reset():void

Reverts the settings to default for use as an itemRenderer.

Event detail
thumbnailLoadedevent 

Dispatched when the thumbnail has loaded and is displayed.