LightboxFormat

Kind of class: public class
Package:
Inherits from:
  • none
Version: 01 May 2010 Can now add link text to bottom right of ImageDisplay content that has hyperlinks
30 Mar 2010 LightboxFormat now uses TextFormat objects for Lightbox TextFields
Author: John Polacek, john@johnpolacek.com
Classpath: com.johnpolacek.components.LightboxFormat
File last modified: Tuesday, 24 Augustus 2010, 17:26:45
The LightboxFormat class represents formatting information. Use the LightboxFormat class to create specific formatting for Lightboxes. You must use the constructor new LightboxFormat() to create a TextFormat object before setting its properties. The Lightbox properties are set to default values so if you don't provide values for the properties, Lightboxes use their own default formatting.

Summary

Constructor
Instance properties
Instance methods

Constructor

LightboxFormat

function LightboxFormat()

Instance properties

audioSubtitleTextFormat

audioSubtitleTextFormat:TextFormat(read,write)

The TextFormat for the audio subtitle TextField.

audioTitleTextFormat

audioTitleTextFormat:TextFormat(read,write)

The TextFormat for the audio title TextField.

backgroundAlpha

backgroundAlpha:Number = .9(read,write)

The transparency alpha value of the overlay background. Default: .9

backgroundColor

backgroundColor:uint = 0xFFFFFF(read,write)

The color of the overlay background Default: 0xFFFFFF

buttonColor

buttonColor:uint = 0x000000(read,write)

The color of the lightbox buttons. Must not be white. . Default: 0x000000

buttonSize

buttonSize:int = 24(read,write)

The size of the close button. Default: 30

contentBackgroundAlpha

contentBackgroundAlpha:Number = 1(read,write)

The color of the content window background. Default: 0xFFFFFF

contentBackgroundColor

contentBackgroundColor:uint = 0xFFFFFF(read,write)

The color of the content window background. Default: 0xFFFFFF

dropShadowAlpha

dropShadowAlpha:Number = .5(read,write)

The transparency alpha value of the content window dropshadow. Default: .5

lightboxHeight

lightboxHeight:int(read,write)

Height of lightbox. Default is 0 (size to stageWidth)

lightboxWidth

lightboxWidth:int(read,write)

Width of lightbox. Default is 0 (size to stageWidth)

linkTextFormat

linkTextFormat:TextFormat(read,write)

The TextFormat for the image link TextField.

margin

margin:Number = 10(read,write)

The margin (in pixels) surrounding the content in the content window. Default: 10

noteTextFormat

noteTextFormat:TextFormat(read,write)

The TextFormat for the note TextField.

subtitleTextFormat

subtitleTextFormat:TextFormat(read,write)

The TextFormat for the subtitle TextField.

titleTextFormat

titleTextFormat:TextFormat(read,write)

The TextFormat for the title TextField.

Instance methods

setFormatFromXML

function setFormatFromXML(xml:XML)

Use xml file to set formatting