redrocketcms.components.RRDescription
Description contains html code. It may contain line breaks, and massive amounts of text, so beware.
Static. This id is the sybolID linkage necessary for dynamic attachment using attachMovie().
Example Usage. Identical functionally to dropping the Description component on the stage:
Write-only. If true, you must have the Macromedia v2 UIScrollBar Component available in your library. This will add the ability to scroll non-autoSized textfields and will also shorten the width of the Component by the width of the scrollbar.
Note you can customize the scrollbar the same way you normally would using the Macromeida v2 Component architecture.
Write-only.
false (default) - the scrollbar will be visible whether or not the textfiled is in fact scrollable. If the textfield dose not require scrolling, and autoHideScrollbar is false, the scrollbar will still be visible, but in a "disabled" state.
true - the component will attempt to decipher if the scrollbar is necessary. If scrolling is not necessary, it will turn off the scrollbar and resize the textfield back to it’s original state. Note: when this happens, there may be a visible "flicker" when the textfield resizes.
Read/Write
1-based (i.e. page 1 is the first page, not 0)
sets the viewable area to the page specified, or returns the current page.
Note: using any of the page properties will set in motion an internal process of creating page metrics, and as a result may (and probably will) create extra line breaks to fill the last page so that there are even pages.
Read-only
returns the total number of pages for the calculated page metrics of the description.
Note: using any of the page properties will set in motion an internal process of creating page metrics, and as a result may (and probably will) create extra line breaks to fill the last page so that there are even pages.
scrolls the description viewable up one page.
returns the current page after the scolling occurs, so if you were on page 2, it would return page 1.
Note: using any of the page properties will set in motion an internal process of creating page metrics, and as a result may (and probably will) create extra line breaks to fill the last page so that there are even pages.
scrolls the description viewable down one page.
returns the current page after the scolling occurs, so if you were on page 2, it would return page 3.
Note: using any of the page properties will set in motion an internal process of creating page metrics, and as a result may (and probably will) create extra line breaks to fill the last page so that there are even pages.
This property has relaxed typing, so you can use it one of two ways.
Method 1: url-based
you can assign a url to this property to apply an external stylesheet to the html. Keep in mind, there will be a slight pause until the stylesheet loads.
Method 2: object-based
you can also pass in an actionscript object based stylesheet. this format is almost instananeous.
This is a static method that effects all RRDescription class instances. This property has relaxed typing, so you can use it one of two ways.
Method 1: url-based
you can assign a url to this property to apply an external stylesheet to the html. Keep in mind, there will be a slight pause until the stylesheet loads.
Method 2: object-based
you can also pass in an actionscript object based stylesheet. this format is almost instananeous.
Event fired when the page property of the description instance changes.
Event that fires when a stylesheet is loaded an applied to the instance. This even tgets fired even if the stylesheet is not external.
Event that fires once the instance is ready. For some strange reason, when applying html to a textfield in flash, the metrics of the textfield are not available immediately. This function fires once the sizes.rendering is complete and ready to go.
redrocketcms.classes.collector.auditable.Context
The base class for contextual classes Title and Description.
Write-only. Sets the font face of the Component. Use "_sans" for non-embedded fonts. Also, keep in mind that the Component sees this value as a String literal, so if you embed fonts in the library, for example "Arial", do not use the psudo-font "*Arial" as it wil not work correctly. A value of "—-" (3 dashes) will not set the format, but allow the formatting from the rich-text editor to control it.
Write-only. Sets the size of the text. A value of "—-" (3 dashes) will not set the format, but allow the formatting from the rich-text editor to control it.
Write-only. Sets the Leading, or line spacing between each line of text. A value of "—-" (3 dashes) will not set the format, but allow the formatting from the rich-text editor to control it.
Write-only. Sets the spacing, in pixels between each character.
Write-only. Sets the text as bold. A value of "—-" (3 dashes) will not set the format, but allow the formatting from the rich-text editor to control it.
Write-only. Sets the text as italic. A value of "—-" (3 dashes) will not set the format, but allow the formatting from the rich-text editor to control it.
Write-only. Sets the justification, or horizontal alignment of the text. Four possible values:
Write-only. Sets the color of the text using hexadecimal notation (0x00000) without parenthesis. A value of "—-" (3 dashes) will not set the format, but allow the formatting from the rich-text editor to control it.
Write-only. If true, allows flash to render the text with internal font outlines. Use caution here. If you set this value to true, but dont embed the font you specify in the "Font Face" property, the text will just fail to show up.
Another important thing to keep in mind is that the Description class contains html text, which may or may not contain bold and italic text. If you choose to embed fonts, and bold and/or italic words exist, those outlines must be embedded in the movie as well, or they too will fail to show up.
Write-only. Sets the sizing method of the textfield. Four possible values:
Note: setting autoSize to anything other than "none" will trigger a "resize" event when it resizes.
Write-only. Sets both the multiline and wordwrap in the same property. Note: Title by default is set to false, Description, by default is set to true.
Write-only. If true, allows the user to select (copy) the text from the textfield.
Write-only. Sets the visibility of the textfield border.
Write-only. If true, sets an opaque background to the textfield.
Write-only. Sets the color of the border. Applies only if the border property is set to true. Use hexadecimal notion without quotes (i.e 0x000000)
Write-only. Sets the color of the background. Applies only if the background property is set to true. Use hexadecimal notion without quotes (i.e 0x000000)
Write-only. Sets the antialiasing of the textfield. The use of "Crisp" or "Sharp" use flash 8’s new text rendring capabilities. There are 3 options, and the floow closely to Adobe Photoshop’s alias settings.
Read/Write. You can read/write the contents of the textfield at will if you wish to overwirte//modify/animate. If the text conatins html code, it will return only the raw text.
Read/Write. You can read/write the contents of the textfield at will if you wish to overwirte//modify/animate. If the text does not contain html code, it will wrap the return text in a html wrapper with all the style information.
Read-only. Returns the width of the text within the bouding box of the textfield.
Read-only. Returns the height of the text within the bouding box of the textfield.
redrocketcms.classes.Collector
The Collector class searches for data within it’s heirarcy. It will search for the closeset Provider and store the data.
The data property is a dump of the data that feeds the Component/Class. Typically, this is an object with properties or sub-objects that have exhaustive data realting to the component.
To find out what is in the data object you could write something like this:
thetainteractive.classes.architecture.Component
This is the base class for any class that is a Libray-based component. This class sets up the EventDispatcher, and base functions.
Sets the size of the bounding box of the component.
param width:Number
the size, in pixels of the width of the component. pass null if you do not want to set a width.
param height:Number
the size, in pixels of the height of the component. pass null if you do not want to set a height.
see also:
width
height
Sets the size of the component width in pixels.
Sets the size of the component height in pixels.
Moves the component.
param x:Number
moves the component x pixels horizontally.
param y:Number
moves the component y pixels vertically.
The invalidate function is a very important function. Usually, invalidate is called internally by other methods to redraw the component.
However, it is a public method, and by calling invalidate() on any component that uses an invalidation routine essentially "redraws" the entire component.
Care should be taken not to continually call invaidate() on any one component on a loop or onEnterFrame() function. invalidate is usually processor and memory intensive for one frame, so be sure to call it when you are sure that you want the component to redraw.
Another note is that many of the components are nested within other components, and they are linked together visually. Therefore, calling invalidate() on one component may cause multiple ares to redraw, again, another reason to use sparingly.
Event dispatched to listeners when the setSize() method is called. Note: this is also called if the width/height propeties are set.
Event Dispathced when the component is moved using the move() method.