RRBody

redrocketcms.components.RRBody

 

The Body class loads in all content into a viewable pane. It is where all content loads. There should ever only be be one Body instance. The Body instance can be used in lieu of a Probe, with the difference being that once the RRC are initialized, it will automatically load the home content. If RRProbe is used, you must manually load the start content.

p id:String

Static. This id is the sybolID linkage necessary for dynamic attachment using attachMovie().

 

Example Usage. Identical functionally to dropping the Body component on the stage:

import redrocketcms.components.RRBody; this.attachMovie(RRBody.id, "body", this.getNextHighestDepth());

p allowExternalBuckets:Boolean (External Buckets - Allow)

Write-only. If set to true, the Body will first try and load the content buckets as external files.

 

For example: if the content bucket id is "my-bucket-2e4f6d" the body will attempt to load "my-bucket-2e4f6d.swf" from the base of the swf. If that file does not exist, it will continute to function as normal.

 

Note: if set to true, there is an additional lag between bucket loading, and additional errors in the IDE trace window for each bucket attempt failure.

p externalBucketBaseURL:String (External Buckets - Base URL)

Write-only. Sets the loading prefix for external buckets.

 

For example: if the content id is "my-bucket-2e4f6d" and the external bucket base URL is "/assets/external/" it will load "/assets/external/my-bucket-2e4f6d.swf".

p jsResizeHandler:String (Javascript Resize Handler)

Write-only. Sets the function name for the javascript sizing function.

 

The default javascript resize handler is "ResizeFlash". The Body will call this function each time a new content bucket loads and/or the Body is invalidated. To enable this feature, you simply need to add a function in javascript to handle the two parameters this function sends.

 

Note: that the width and height paramters are of the Body, NOT of the final dimensions. You will need to do your own calculations on how to resize properly with the offsets of you movie.

 

Example: (in javascript)

function ResizeFlash (width, height) { // do something to resize }

m loadHome():Void

If the Body instance isnt the first RR component to initialize (say if you used RRProbe) the Body will not load the home content on it’s own. If the body gets created after the RRC get initialized, you can call this function to begin the loading process.

m home():Void (static)

the static version of the loadHome() method

m load (str:String):Void (static)

The static version of loadPage()

m loadPage(str:String):Void

This function will load a specific content bucket into the body.

 

param str:String

the hashkey of the content bucket to load

p autoBuild:Boolean (Auto Build Content)

If this is set to true, the body will automatically destroy the old content and draw the next incoming content bucket as soon as the data comes in.

 

If it’s false, you will have to manually call build() statically on the body component to draw it, and maually delete the content that is currently visible.

 

This is useful if you want to create a transition between pages of the site, but it’s certainly an advanced usage.

m build():Void (static)

This function, if autoBuild is set to false, will draw the next content buckt that is loaded. If the data for the bucket has not fully loaded, it will wait until it is loaded before it builds out.

Scrollable

redrocketcms.classes.collector.auditable.Scrollable

 

The Scollable class adds ScrollPane functionality to certain classes. For this to function, you will need the Macromedia v2 ScrollPane Component available in the library.

p useScrollPane:Boolean (Use ScrollPane)

Write-only. If set to true, the component will use the scrollpane to add scrolling ability to the content.

p scrollpane:MovieClip

Read-only. Returns the instance of the Macromedia v2 ScrollPane component. From this, you can interact with the component just as you would normally (i.e. setting vScrollPolicy, etc).

p useClippingMask:Boolean (Use Clipping Mask)

Write-only. If useScrollpane is set to false, this property handles how overflow information that falls outside of the bounding box is handled. If true, only the visible bounding box area of the component will be visible. Otherwise, no clipping will occur, and it will all be shown.

p content:MovieClip

Read-only. Returns the actual content from the ContentHolder class. This Movieclip is the actual rendered content, and is not an intermediay class.

p holder:MovieClip

Read-only. Returns the intermediary instance of the ContentHolder Class that holds the actual content.

Auditable

redrocketcms.classes.collector.Auditable

 

The auditable is the class adds the first set of Component Inspectable properties. Any library-based Components will become a child of this class.

p hSizePolicy:Boolean (Size Policy - Horizontal)

Write-only. The horizontal size policy instructs the component to resize itself to match the maximum width of the component’s containing objects.

p vSizePolicy:Boolean (Size Policy - Vertical)

Write-only. The vertical size policy instructs the component to resize itself to match the maximum height of the component’s containing objects.

Collector

redrocketcms.classes.Collector

 

The Collector class searches for data within it’s heirarcy. It will search for the closeset Provider and store the data.

p data:Object

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:

// where _api is the component/class you are trying to read from. var data = _api.data; for (var prop in data) trace (prop + ": " + data[prop]);

Component

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.

m setSize(width:Number, height:Number):Void

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

p width:Number

Sets the size of the component width in pixels.

p height:Number

Sets the size of the component height in pixels.

m move(x:Number, y:Number):Void

Moves the component.

 

param x:Number

moves the component x pixels horizontally.

 

param y:Number

moves the component y pixels vertically.

m invalidate()

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.

e resize()

Event dispatched to listeners when the setSize() method is called. Note: this is also called if the width/height propeties are set.

e move()

Event Dispathced when the component is moved using the move() method.