Class CAAT.Foundation.UI.Dock

Extends CAAT.Foundation.ActorContainer.

Defined in: Dock.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	CAAT.Foundation.UI.Dock()

Field Summary
Field Attributes	Field Name and Description
	layoutOp Any value from CAAT.Foundation.Dock.UI.OP_LAYOUT_*
	maxSize max contained actor size
	minSize min contained actor size.
<static>	CAAT.Foundation.UI.Dock.OP_LAYOUT_BOTTOM
<static>	CAAT.Foundation.UI.Dock.OP_LAYOUT_LEFT
<static>	CAAT.Foundation.UI.Dock.OP_LAYOUT_RIGHT
<static>	CAAT.Foundation.UI.Dock.OP_LAYOUT_TOP
	range aproximated number of elements affected.
	scene scene the actor is in.
	ttask resetting dimension timer task.

Fields borrowed from class CAAT.Foundation.ActorContainer:: activeChildren, addHint, boundingBox, childrenList, layoutInvalidated, layoutManager, pendingChildrenList, runion
Fields borrowed from class CAAT.Foundation.Actor:: __super, AABB, alpha, backgroundImage, behaviorList, cached, clip, clipPath, dirty, discardable, duration, expired, fillStyle, frameAlpha, gestureEnabled, glEnabled, height, id, inFrame, invalid, isAA, isCachedActor, isGlobalAlpha, lifecycleListenerList, minimumSize, modelViewMatrix, modelViewMatrixI, mouseEnabled, oldX, oldY, parent, pointed, preferredSize, preventLayout, rotationAngle, rotationX, rotationY, scaleAnchor, scaleTX, scaleTY, scaleX, scaleY, size_active, size_total, start_time, strokeStyle, tAnchorX, tAnchorY, time, viewVertices, visible, wdirty, width, worldModelViewMatrix, worldModelViewMatrixI, x, y

Method Summary
Method Attributes	Method Name and Description
<private>	actorMouseEnter(mouseEvent) Perform the beginning of docking elements.
<private>	actorMouseExit(mouseEvent) Perform the process of exiting the docking element, that is, animate elements to the minimum size.
<private>	actorNotPointed() Performs operation when the mouse is not in the dock element.
<private>	actorPointed(x, y, pointedActor) Perform the process of pointing a docking actor.
	addChild(actor) Adds an actor to Dock.
	initialize(scene)
<private>	layout() Lay out the docking elements.
	mouseExit(mouseEvent)
	mouseMove(mouseEvent)
	setApplicationRange(range) Set the number of elements that will be affected (zoomed) when the mouse is inside the component.
	setLayoutOp(lo) Set layout orientation.
	setSizes(min, max) Set maximum and minimum size of docked elements.

Methods borrowed from class CAAT.Foundation.ActorContainer:: __init, __paintActor, __validateLayout, __validateTree, addActor, addActorImmediately, addChildAt, addChildDelayed, addChildImmediately, animate, destroy, drawScreenBoundingBox, emptyChildren, endAnimate, findActorAtPosition, findActorById, findChild, getChildAt, getLayout, getNumActiveChildren, getNumChildren, invalidateLayout, paintActor, paintActorGL, recalcSize, removeChild, removeChildAt, removeFirstChild, removeLastChild, setBounds, setLayout, setZOrder
Methods borrowed from class CAAT.Foundation.Actor:: __scale1To, addAnimation, addBehavior, addListener, cacheAsBitmap, centerAt, centerOn, clean, contains, create, disableDrag, emptyBehaviorList, enableDrag, enableEvents, fireEvent, gestureChange, gestureEnd, gestureStart, getAnchor, getAnchorPercent, getBehavior, getId, getMinimumSize, getPreferredSize, getTextureGLPage, glNeedsFlush, glSetShader, invalidate, isCached, isGestureEnabled, isInAnimationFrame, isVisible, modelToModel, modelToView, mouseClick, mouseDblClick, mouseDown, mouseDrag, mouseEnter, mouseOut, mouseOver, mouseUp, moveTo, paint, playAnimation, removeBehaviorById, removeBehaviour, removeListener, resetAnimationTime, resetAsButton, resetTransform, rotateTo, scaleTo, scaleXTo, scaleYTo, setAlpha, setAnimationEndCallback, setAnimationImageIndex, setAsButton, setBackgroundImage, setBackgroundImageOffset, setButtonImageIndex, setCachedActor, setChangeFPS, setClip, setDiscardable, setExpired, setFillStyle, setFrameTime, setGestureEnabled, setGLCoords, setGlobalAlpha, setGlobalAnchor, setId, setImageTransformation, setLocation, setMinimumSize, setModelViewMatrix, setOutOfFrameTime, setPaint, setParent, setPosition, setPositionAnchor, setPositionAnchored, setPreferredSize, setPreventLayout, setRotation, setRotationAnchor, setRotationAnchored, setScale, setScaleAnchor, setScaleAnchored, setScreenBounds, setSize, setSpriteIndex, setStrokeStyle, setUV, setVisible, stopCacheAsBitmap, touchEnd, touchMove, touchStart, viewToModel

Class Detail

CAAT.Foundation.UI.Dock()

Field Detail

layoutOp

Any value from CAAT.Foundation.Dock.UI.OP_LAYOUT_*

maxSize

max contained actor size

minSize

min contained actor size.

<static> CAAT.Foundation.UI.Dock.OP_LAYOUT_BOTTOM

<static> CAAT.Foundation.UI.Dock.OP_LAYOUT_LEFT

<static> CAAT.Foundation.UI.Dock.OP_LAYOUT_RIGHT

<static> CAAT.Foundation.UI.Dock.OP_LAYOUT_TOP

range

aproximated number of elements affected.

scene

scene the actor is in.

ttask

resetting dimension timer task.

Method Detail

<private> actorMouseEnter(mouseEvent)

Perform the beginning of docking elements.

Parameters:
mouseEvent: {CAAT.MouseEvent} a CAAT.MouseEvent object.

<private> actorMouseExit(mouseEvent)

Perform the process of exiting the docking element, that is, animate elements to the minimum size.

Parameters:
mouseEvent: {CAAT.MouseEvent} a CAAT.MouseEvent object.

<private> actorNotPointed()

Performs operation when the mouse is not in the dock element.

<private> actorPointed(x, y, pointedActor)

Perform the process of pointing a docking actor.

Parameters:
x: {number}
y: {number}
pointedActor: {CAAT.Actor}

addChild(actor)

Adds an actor to Dock.

Be aware that actor mouse functions must be set prior to calling this method. The Dock actor needs set his own actor input events functions for mouseEnter, mouseExit and mouseMove and will then chain to the original methods set by the developer.

Parameters:
actor: {CAAT.Actor} a CAAT.Actor instance.

Returns:: this

initialize(scene)

Parameters:
scene

<private> layout()

Lay out the docking elements. The lay out will be a row with the orientation set by calling the method setLayoutOp.

mouseExit(mouseEvent)

Parameters:
mouseEvent

mouseMove(mouseEvent)

Parameters:
mouseEvent

setApplicationRange(range)

Set the number of elements that will be affected (zoomed) when the mouse is inside the component.

Parameters:
range: {number} a number. Defaults to 2.

setLayoutOp(lo)

Set layout orientation. Choose from

CAAT.Dock.OP_LAYOUT_BOTTOM
CAAT.Dock.OP_LAYOUT_TOP
CAAT.Dock.OP_LAYOUT_BOTTOM
CAAT.Dock.OP_LAYOUT_RIGHT

By default, the layou operation is OP_LAYOUT_BOTTOM, that is, elements zoom bottom anchored.

Parameters:
lo: {number} one of CAAT.Dock.OP_LAYOUT_BOTTOM, CAAT.Dock.OP_LAYOUT_TOP, CAAT.Dock.OP_LAYOUT_BOTTOM, CAAT.Dock.OP_LAYOUT_RIGHT.

Returns:: this

setSizes(min, max)

Set maximum and minimum size of docked elements. By default, every contained actor will be of 'min' size, and will be scaled up to 'max' size.

Parameters:
min: {number}
max: {number}

Returns:: this

Classes

Class CAAT.Foundation.UI.Dock