ch.aplu.android

Class GGPushButton

java.lang.Object

ch.aplu.android.Actor

ch.aplu.android.GGButtonBase

ch.aplu.android.GGPushButton

All Implemented Interfaces:

GGActorCollisionListener, GGBorderListener, GGTileCollisionListener, java.util.EventListener

public class GGPushButton
extends GGButtonBase

Class that implements a button actor with standard behavior. Button events 'left entered', 'left exited', 'left pressed', 'left released' and 'left clicked' are reported by a registered GGButtonListener.

The button is centered in the middle of a cell. Use Actor.setLocationOffset() to fine tune the button location.

3 sprites are used: one for the released state, one for the pressed state and one for the rollover state.

Field Summary

Fields inherited from class ch.aplu.android.Actor

gameGrid, nbCycles

Constructor Summary

Constructors

Constructor and Description
GGPushButton(java.lang.String buttonImage) Creates a button from the given sprite images.

Method Summary

Methods

Modifier and Type	Method and Description
void	addPushButtonListener(GGPushButtonListener listener) Registers a GGPushButtonListener to get notifications when the button is manipulated.
boolean	isPressed() Returns the current state of the ButtonA.
void	setRepeatDelay(int delayTime) Sets the delay between the buttonPressed event until the first buttonRepeat event.
void	setRepeatPeriod(int period) Sets the period of succeeding buttonRepeated() notifications.

Methods inherited from class ch.aplu.android.GGButtonBase

isEnabled, setEnabled, setHotspotArea, setRefreshEnabled

Methods inherited from class ch.aplu.android.Actor

act, addActorCollisionListener, addActorTouchListener, addActorTouchListener, addBorderListener, addCollisionActor, addCollisionActors, addCollisionTile, addCollisionTiles, addTileCollisionListener, collide, collide, containsPixel, delay, displace, getBackground, getCollisionActors, getCollisionActorsInRange, getCollisionTiles, getCurrentImage, getDirection, getDirectionStart, getDisplacePosition, getHeight, getIdVisible, getImage, getImage, getIntDirection, getLocation, getLocationOffset, getLocationStart, getNbCycles, getNbHorzCells, getNbSprites, getNbVertCells, getNeighbours, getNeighbours, getNextMoveLocation, getPixelColor, getPixelLocation, getRotatedImage, getRotatedPosition, getRotationIndex, getScaledImage, getScaledImage, getScaledImage, getSlowDown, getWidth, getX, getXStart, getY, getYStart, getZoomedImage, hide, isActEnabled, isActorCollisionEnabled, isHorzMirror, isInGrid, isMoveValid, isNearBorder, isRemoved, isRotatable, isTileCollisionEnabled, isVertMirror, isVisible, move, move, nearBorder, removeSelf, reset, rotate, rotate, setActEnabled, setActorCollisionEnabled, setActorTouchCircle, setActorTouchCircle, setActorTouchEnabled, setActorTouchImage, setActorTouchImage, setActorTouchRectangle, setActorTouchRectangle, setCollisionCircle, setCollisionCircle, setCollisionImage, setCollisionImage, setCollisionLine, setCollisionLine, setCollisionRectangle, setCollisionRectangle, setCollisionSpot, setCollisionSpot, setDirection, setDirection, setDisplacePosition, setHorzMirror, setLocation, setLocationOffset, setLocationOffset, setOnBottom, setOnTop, setPixelLocation, setSlowDown, setTileCollisionEnabled, setVertMirror, setX, setY, show, show, showNextSprite, showPreviousSprite, turn

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GGPushButton

public GGPushButton(java.lang.String buttonImage)

Creates a button from the given sprite images. Multiple sprites are assumed, using the implicite underline convention. image_0.gif corresponds to the released state, image_1.gif to the pressed state.

Parameters:

buttonImage - the filename or URL of the two sprites

Method Detail

isPressed

public boolean isPressed()

Returns the current state of the ButtonA. The button must be enabled by calling addPushButtonListener(), even if the GGPushButtonListener is not used.

Returns:

true, if the button is pressed; otherwise false

addPushButtonListener

public void addPushButtonListener(GGPushButtonListener listener)

Registers a GGPushButtonListener to get notifications when the button is manipulated. The default hotspot area is the button image bounding rectangle.

Parameters:

listener - the GGButtonListener to register

setRepeatPeriod

public void setRepeatPeriod(int period)

Sets the period of succeeding buttonRepeated() notifications.

Parameters:

period - the time between buttonRepeat() notifications (in ms, default: 200 ms)

setRepeatDelay

public void setRepeatDelay(int delayTime)

Sets the delay between the buttonPressed event until the first buttonRepeat event.

Parameters:

delayTime - the delay until the first buttonRepeat() notification is generated (in ms, default: 400 ms)