Main Page | Packages | Class Tree | Index | Help
Previous | NextFrames | No Frames
Summary: Field | Property | Contructor | MethodDetail: Field | Property | Contructor | Method
com.bjc.core

class BJCComponent

MovieClip
  |
  +--com.bjc.core.BJCComponent

All Known Subclasses: Calendar, ColorChooser, GroupBox, HResizer, HSlider, IconButton, Knob, LabelWrapper, Loader, PlayerControl, Resizer, ScrollBar, ScrollPane, VideoPlayer, VResizer, VSlider
class BJCComponent
extends MovieClip

Base class for all BJC Bit Components.


Author:
Flashloaded - www.flashloaded.com

Field Summary

public
version: String


Property Summary

public
disabledAlpha: Number (write)
Sets the alpha value of the disabled component.

public
disabledAlpha: Number (read)
Retrieves the alpha value of the disabled component.

public
enabled: Boolean (write)
If true, component will function normally; if false, component will appear grayed out and will not respond to user input.

public
enabled: Boolean (read)
Receives component availability.

public
focusTime: Number (write)
Sets the time (in milliseconds) the focus of the component remains visible. The variable _global.bitFocusTime applies to all bit components. If focusTime is set, it will override the global variable.

public
focusTime: Number (read)
Gets the time (in milliseconds) the focus of the component remains visible.

public
height: Number (write)
Sets the height of the component.

public
height: Number (read)
Retrieves the height of the component.

public
keyEnabled: Boolean (write)
Sets the keyEnabled mode of the component. If set to true, the component will accept key events.

public
keyEnabled: Boolean (read)
Gets the keyEnabled mode of the component.

public
style: Object (write-only)
Used to pass a set of styles to the component. Any properties of the object passed to the style member will be applied to the component.

public
width: Number (write)
Sets the width of the component.

public
width: Number (read)
Retrieves the width of the component.

Constructor

public
BJCComponent ( Void)
public static var globalStyle:Object;

Method Summary

public
draw ( Void ): Void
Forces an immediate redraw of the component, though generally invalidate() is preferred.

public
invalidate ( Void ): Void
Marks the component to be redrawn on the next frame.

public
move ( x: Number, y: Number ): Void
Places the component at the specified x/y position.

public
remove ( Void ): Void
Removes component from stage. Handles any depth issues first that would prevent the component from being removed and then calls removeMovieClip.

public
setSize ( w: Number, h: Number ): Void
Sizes the component to the measurements specified.


Field Documentation

version

public var version: String

Property Documentation

disabledAlpha

public disabledAlpha: Number (write)
Sets the alpha value of the disabled component.

Example:
myComponent.disabledAlpha = 50;

disabledAlpha

public disabledAlpha: Number (read)
Retrieves the alpha value of the disabled component.

Example:
myVar = myComponent.disabledAlpha;

enabled

public enabled: Boolean (write)
If true, component will function normally; if false, component will appear grayed out and will not respond to user input.

Example:
myComponent.enabled = false;

enabled

public enabled: Boolean (read)
Receives component availability.

Example:
myVar = myComponent.enabled;

focusTime

public focusTime: Number (write)
Sets the time (in milliseconds) the focus of the component remains visible. The variable _global.bitFocusTime applies to all bit components. If focusTime is set, it will override the global variable.

Example:
myComponent.focusTime = 500;
// or
_global.bitFocusTime = 1000;

focusTime

public focusTime: Number (read)
Gets the time (in milliseconds) the focus of the component remains visible.

Example:
myVar = myComponent.focusTime;

height

public height: Number (write)
Sets the height of the component.

Example:
myComponent.height = 100;

height

public height: Number (read)
Retrieves the height of the component.

Example:
myVar = myComponent.height;

keyEnabled

public keyEnabled: Boolean (write)
Sets the keyEnabled mode of the component. If set to true, the component will accept key events.

Example:
myComponent.keyEnabled = false;

keyEnabled

public keyEnabled: Boolean (read)
Gets the keyEnabled mode of the component.

Example:
myVar = myComponent.keyEnabled;

style

public style: Object (write-only)
Used to pass a set of styles to the component. Any properties of the object passed to the style member will be applied to the component.

Example:
myStyle = {fontSize:20, fontColor:0xff0000};
myButton.style = myStyle;

width

public width: Number (write)
Sets the width of the component.

Example:
myComponent.width = 100;

width

public width: Number (read)
Retrieves the width of the component.

Example:
myVar = myComponent.width;

Constructor Documentation

BJCComponent

public function BJCComponent(Void)
public static var globalStyle:Object;

Method Documentation

draw

public function draw(Void): Void
Forces an immediate redraw of the component, though generally invalidate() is preferred.

Returns:
nothing

Example:
myComponent.draw();

invalidate

public function invalidate(Void): Void
Marks the component to be redrawn on the next frame.

Returns:
nothing

Example:
myComponent.invalidate();

move

public function move(x: Number,
 y: Number): Void
Places the component at the specified x/y position.

Parameters:
x
the position on the x axis to place the component.
y
the position on the y axis to place the component.
Returns:
nothing

Example:
myComponent.move(100, 100);

remove

public function remove(Void): Void
Removes component from stage. Handles any depth issues first that would prevent the component from being removed and then calls removeMovieClip.

Returns:
nothing

Example:
myComponent.remove();

setSize

public function setSize(w: Number,
 h: Number): Void
Sizes the component to the measurements specified.

Parameters:
w
the new width of the component.
h
the new height of the component.
Returns:
nothing

Example:
myComponent.setSize(100, 100);

The documentation was generated from the following file:

Copyright Flashloaded - www.flashloaded.com