Class Index | File Index

Classes


Class R.ui.FieldGroup


Extends R.ui.AbstractUIControl.
A physical grouping of UI controls.
Defined in: fieldgroup.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Fields borrowed from class R.struct.Container:
EMPTY
Method Summary
Method Attributes Method Name and Description
 
addControl(uiControl)
Add a control to this field group.
 
deserialize(obj, clazz)
Deserialize the object back into a field group.
 
Destroy the text input control, releasing its event handlers.
 
drawControl(renderContext, worldTime, dt)
Draw the field group within the context.
 
Get the class name of this object
 
getControlByName(controlName)
Get the first control, within the field group, which has the specified name, or null if no control with the name is in the group.
 
Get the field group label.
 
Releases the object back into the object pool.
 
removeControl(uiControl)
Remove a control from this field group.
 
serialize(obj, defaults)
Get a properties object with values for the given object.
 
setLabel(label)
Set the label for the field group, or an empty string to show no label.
Methods borrowed from class R.ui.AbstractUIControl:
addClass, calcHeight, calcWidth, click, drawBox, getControlName, getGroup, getGroupName, getProperties, getTextRenderer, hasFocus, isMouseInControl, mouseDown, mouseMove, mouseOut, mouseOver, mouseUp, removeClass, setControlName, setFocus, setGroup
Methods borrowed from class R.objects.Object2D:
getAABB, getBoundingBox, getBoundingCircle, getCollisionHull, getDefaultTransformComponent, getLastPosition, getOrigin, getOriginPosition, getPosition, getRenderPosition, getRenderRotation, getRotation, getScale, getScaleX, getScaleY, getTransformationMatrix, getWorldBox, getWorldCircle, getZIndex, setBoundingBox, setCollisionHull, setDefaultTransformComponent, setOrigin, setPosition, setRotation, setScale, setZIndex
Methods borrowed from class R.engine.GameObject:
add, componentSort, getComponent, getComponentByClass, getRenderContext, isDirty, isKeepAlive, markDirty, remove, setKeepAlive, setRenderContext, update, wasDirty
Methods borrowed from class R.struct.HashContainer:
cleanUp, clear, get, isInHash, removeAtIndex, removeHash
Methods borrowed from class R.struct.Container:
addAll, append, clone, concat, contains, filter, forEach, fromArray, getAll, getObjects, insert, iterator, reduce, replace, replaceAt, size, sort, subset, toXML
Methods borrowed from class R.engine.BaseObject:
addEvent, addEvents, getElement, jQ, removeEvent, setElement, triggerEvent
Methods borrowed from class R.engine.PooledObject:
clearObjectDataModel, getId, getName, getObjectDataModel, isDestroyed, setName, setObjectDataModel, toString
Class Detail
R.ui.FieldGroup(label)
Parameters:
label
{String} The label for the field group.
Method Detail
addControl(uiControl)
Add a control to this field group.
Parameters:
uiControl
{R.ui.AbstractUIControl} The control to add

{R.ui.ButtonControl} deserialize(obj, clazz)
Deserialize the object back into a field group.
Parameters:
obj
{Object} The object to deserialize
clazz Optional
{Class} The object class to populate
Returns:
{R.ui.ButtonControl} The object which was deserialized

destroy()
Destroy the text input control, releasing its event handlers.

drawControl(renderContext, worldTime, dt)
Draw the field group within the context.
Parameters:
renderContext
{R.rendercontexts.RenderContext2D} The render context where the control is drawn.
worldTime
{Number} The current world time, in milliseconds
dt
{Number} The time since the last frame was drawn by the engine, in milliseconds

{String} getClassName()
Get the class name of this object
Returns:
{String} The string "R.ui.FieldGroup"

{R.ui.AbstractUIControl} getControlByName(controlName)
Get the first control, within the field group, which has the specified name, or null if no control with the name is in the group.
Parameters:
controlName
{String} The name of the control to get
Returns:
{R.ui.AbstractUIControl} The control, or null

{String} getLabel()
Get the field group label.
Returns:
{String}

release()
Releases the object back into the object pool. See R.engine.PooledObject#release for more information.

{R.ui.AbstractUIControl} removeControl(uiControl)
Remove a control from this field group.
Parameters:
uiControl
{R.ui.AbstractUIControl} The control to remove
Returns:
{R.ui.AbstractUIControl} The control removed

{Object} serialize(obj, defaults)
Get a properties object with values for the given object.
Parameters:
obj
{R.ui.FieldGroup} The field group to query
defaults Optional
{Object} Default values that don't need to be serialized unless they are different.
Returns:
{Object}

setLabel(label)
Set the label for the field group, or an empty string to show no label.
Parameters:
label
{String} The label

Documentation generated by JsDoc Toolkit 2.4.0 on Mon Mar 18 2013 16:09:21 GMT-0400 (EDT)