Class lime.Button
Extends
lime.Layer.
Defined in: button.js.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
lime.Button(opt_upstate, opt_downstate)
Simple button element
|
| Field Attributes | Field Name and Description |
|---|---|
| <static> |
lime.Button.Event
Button event names
|
| <static> |
lime.Button.State
Button states
|
- Fields borrowed from class lime.Node:
- customEvent_, eventHandlers_, inTree_, supportedRenderers, transitionsAdd_, transitionsClear_
| Method Attributes | Method Name and Description |
|---|---|
|
getState()
Returns current state of the button
|
|
|
setDownState(downstate)
Sets the sprite used as button down state.
|
|
|
setState(value)
Sets the state of the button.
|
|
|
setUpState(upstate)
Sets the sprite used as button up state
|
- Methods borrowed from class lime.Layer:
- hitTest
- Methods borrowed from class lime.Node:
- addDependency, addEventListener, addTransition, appendChild, calcRelativeQuality, clearTransition, createDomElement, getAnchorPoint, getAutoResize, getBoundingBox, getChildAt, getChildIndex, getDeepestDomElement, getDeepestParentWithDom, getDirector, getDirty, getFrame, getHidden, getMask, getNumberOfChildren, getOpacity, getParent, getParentStack_, getPosition, getQuality, getRelativeQuality, getRotation, getScale, getScene, getSize, localToNode, localToParent, localToScreen, measureContents, needsDomElement, parentToLocal, releaseDependencies, removeAllChildren, removeChild, removeChildAt, removeDependency, removeDomElement, removeEventListener, runAction, screenToLocal, setAnchorPoint, setAutoResize, setChildIndex, setDirty, setHidden, setMask, setOpacity, setPosition, setQuality, setRenderer, setRotation, setScale, setSize, setupDependencies, update, updateDomElement, updateLayout, wasAddedToTree, wasRemovedFromTree
Class Detail
lime.Button(opt_upstate, opt_downstate)
Simple button element
- Parameters:
- {lime.Sprite} opt_upstate
- Object shown on normal state.
- {lime.Sprite} opt_downstate
- Object show when button is pressed.
Field Detail
<static>
lime.Button.Event
Button event names
<static>
lime.Button.State
Button states
Method Detail
{lime.Button.State}
getState()
Returns current state of the button
- Returns:
- {lime.Button.State} current state.
{lime.Button}
setDownState(downstate)
Sets the sprite used as button down state. Down state is hown if
mouse is down on button or finger is touching the button.
- Parameters:
- {lime.Sprite} downstate
- Object shown when button is pressed.
- Returns:
- {lime.Button} object itself.
{lime.Button}
setState(value)
Sets the state of the button. Also fires events is state changes.
- Parameters:
- {lime.Button.State} value
- State to be set.
- Returns:
- {lime.Button} object itself.
{lime.Button}
setUpState(upstate)
Sets the sprite used as button up state
- Parameters:
- {lime.Sprite} upstate
- Object shown on normal state.
- Returns:
- {lime.Button} object itself.