LightboxContentInfo

Kind of class: public class
Package:
Inherits from:
  • none
Version: 07 May 2010 Added createContentArrayFromString method for creating arrays of LightboxContentInfoObjects from specially coded strings
01 May 2010 Created link, linkText and linkTextFormat properties for images with hyperlinks
27 Mar 2010
Author: John Polacek, john@johnpolacek.com
Classpath: com.johnpolacek.components.LightboxContentInfo
File last modified: Tuesday, 24 Augustus 2010, 17:26:45
The LightboxContentInfo class contains information for a single piece of content that is displayed by the Lightbox in the LightboxWindow.

Summary

Instance properties
  • url : String
    • The url string for the content to be displayed.
  • title : String
    • The text in the title TextField.
  • subtitle : String
    • The text in the subtitle TextField.
  • note : String
    • The text in the note TextField.
  • backgroundColor : uint
    • The color of the content backgound.
  • link : String
    • (ImageDisplay only) A hyperlink to display in a new window on mouse click.
  • linkText : String
    • The TextFormat for the ImageDisplay link textfield.
  • linkTextFormat : TextFormat
    • The text that appears on top of the ImageDisplay indicating a link (i.e.
  • flashWidth : Number
    • Width (in pixels) of the FlashDisplay.
  • flashHeight : Number
    • Height (in pixels) of the FlashDisplay.
  • flashBackgroundAlpha : Number
    • The alpha of flash content backgound.
  • flashBackgroundColor : uint
    • The color of flash content backgound.
  • audioTitles
    • For audio content, an array of titles for each audio file.
  • audioSubtitles
    • For audio content, an array of subtitles for each audio file.
  • audioTitleTextFormat : TextFormat
    • The TextFormat for the AudioDisplay title TextFields.
  • audioSubtitleTextFormat : TextFormat
    • The TextFormat for the AudioDisplay subtitle TextFields.
  • audioPlayerWidth : Number
    • Width (in pixels) of audio player.
  • audioPlayerHeight : Number
    • Height (in pixels) of audio player (not inluding progress bar).
  • audioButtonColor : uint
    • Color of audio player buttons.
  • audioTrackColor : uint
    • Audio player track color.
  • audioTrackAlpha : Number
    • Audio player track alpha.
  • audioBackgroundColor : uint
    • The color of the audio player backgound TextField.
Class methods
Instance methods

Instance properties

audioBackgroundColor

audioBackgroundColor:uint = 0x000000(read,write)

The color of the audio player backgound TextField. Default: 0x00000000

audioButtonColor

audioButtonColor:uint = 0xFFFFFF(read,write)

Color of audio player buttons. Default is 0xFFFFFF

audioPlayerHeight

audioPlayerHeight:Number = 50(read,write)

Height (in pixels) of audio player (not inluding progress bar). Default is 50

audioPlayerWidth

audioPlayerWidth:Number = 400(read,write)

Width (in pixels) of audio player. Default is 400

audioSubtitleTextFormat

audioSubtitleTextFormat:TextFormat(read,write)

The TextFormat for the AudioDisplay subtitle TextFields.

audioSubtitles

audioSubtitles = [](read,write)

For audio content, an array of subtitles for each audio file. Default: []

audioTitleTextFormat

audioTitleTextFormat:TextFormat(read,write)

The TextFormat for the AudioDisplay title TextFields.

audioTitles

audioTitles = [](read,write)

For audio content, an array of titles for each audio file. Default: []

audioTrackAlpha

audioTrackAlpha:Number = 1(read,write)

Audio player track alpha. Default is 1

audioTrackColor

audioTrackColor:uint = 0x666666(read,write)

Audio player track color. Default is 0x666666

backgroundColor

backgroundColor:uint = 0xFFFFFF(read,write)

The color of the content backgound. Default: 0xFFFFFF

flashBackgroundAlpha

flashBackgroundAlpha:Number(read,write)

The alpha of flash content backgound. Default: 0

flashBackgroundColor

flashBackgroundColor:uint = 0xFFFFFF(read,write)

The color of flash content backgound. Default: 0xFFFFFF

flashHeight

flashHeight:Number(read,write)

Height (in pixels) of the FlashDisplay. Default is 0 (auto sized)

flashWidth

flashWidth:Number(read,write)

Width (in pixels) of the FlashDisplay. Default is 0 (auto sized)

linkText

linkText:String = ""(read,write)

The TextFormat for the ImageDisplay link textfield.

linkTextFormat

linkTextFormat:TextFormat(read,write)

The text that appears on top of the ImageDisplay indicating a link (i.e. Click to visit)

note

note:String = ""(read,write)

The text in the note TextField. Default: ""

subtitle

subtitle:String = ""(read,write)

The text in the subtitle TextField. Default: ""

title

title:String = ""(read,write)

The text in the title TextField. Default: ""

url

url:String = ""(read,write)

The url string for the content to be displayed.

Class methods

createContentArrayFromString

static function createContentArrayFromString(string:String) : Array

Returns an array of LightboxContentInfo objects from an encoded string. The string should follow this format: {url:image.jpg;title:A title},{url:image2.jpg} Automatically strips out new lines and tabs.

Parameters
string:The encoded string with property assignments.

Instance methods

createPropertiesFromString

function createPropertiesFromString(infoString:String) : void