Packageorg.openvideoplayer.cc
Classpublic class CaptionFormat
InheritanceCaptionFormat Inheritance Object

Represents formatting for a caption object. Typical use for this class would be to format a UI component's html text using a TextRange object in Flex, or Flash developers might use the setTextFormat method of the TextField class.


Public Properties
 PropertyDefined By
  endIndex : int
[read-only] Get the end index supplied to the constructor.
CaptionFormat
  startIndex : int
[read-only] Get the start index supplied to the constructor.
CaptionFormat
  styleObj : Style
[read-only] Get the style object supplied to the constructor.
CaptionFormat
Public Methods
 MethodDefined By
  
CaptionFormat(styleObj:Style, start:int = -1, end:int = -1)
Creates a CaptionFormat object specifying the Style object and the zero-based start and end indices of the range.
CaptionFormat
Property Detail
endIndexproperty
endIndex:int  [read-only]

Get the end index supplied to the constructor.


Implementation
    public function get endIndex():int
startIndexproperty 
startIndex:int  [read-only]

Get the start index supplied to the constructor.


Implementation
    public function get startIndex():int
styleObjproperty 
styleObj:Style  [read-only]

Get the style object supplied to the constructor.


Implementation
    public function get styleObj():Style
Constructor Detail
CaptionFormat()Constructor
public function CaptionFormat(styleObj:Style, start:int = -1, end:int = -1)

Creates a CaptionFormat object specifying the Style object and the zero-based start and end indices of the range.

Parameters
styleObj:Style — The instance of the org.openvideoplayer.cc.Style object to apply.
 
start:int (default = -1) — The optional zero-based index position specifying the first character of the desired range of text. Default is to start with the first character.
 
end:int (default = -1) — The optional zero-based index position specifying the last character of the desired range of text. Default is to end with the last character.




Fri Jan 21 2011, 02:09 PM -08:00