By default, Buttons use pixel level checking for intersection tests. Use {@link ImageSprite#setPixelLevelChecks(boolean) } to disable this feature. */ public class Button extends ImageSprite { // For labeled button creation. See createLabeledButton(). private static final int MARGIN = 12; private static final int MIN_WIDTH = 72; private static final int NORMAL = 0; private static final int HOVER = 1; private static final int PRESSED = 2; private static final int PRESSED_BUT_OUTSIDE = 3; private static final int NUM_VISIBLE_STATES = 3; private final CoreImage[] images; private final boolean isToggleButton; private int[] keyBinding; private int state; private boolean isSelected; private boolean isClicked; private Group rootWhenPressed; /** @param images an array of three images: normal, hover, and pressed. */ public Button(CoreImage[] images, int x, int y) { this(images, x, y, false); } /** @param images an array of three images: normal, hover, and pressed. Use six images for toggle buttons (unselected and selected). */ public Button(CoreImage[] images, int x, int y, boolean isToggleButton) { super(images[0], x, y); this.isToggleButton = isToggleButton; this.images = new CoreImage[images.length]; init(images, isToggleButton); } /** @param images an array of three images: normal, hover, and pressed. */ public Button(CoreImage[] images, double x, double y) { this(images, x, y, false); } /** @param images an array of three images: normal, hover, and pressed. Use six images for toggle buttons (unselected and selected). */ public Button(CoreImage[] images, double x, double y, boolean isToggleButton) { super(images[0], x, y); this.isToggleButton = isToggleButton; this.images = new CoreImage[images.length]; init(images, isToggleButton); } private void init(CoreImage[] images, boolean isToggleButton) { if (images.length < (isToggleButton?6:3)) { throw new IllegalArgumentException("Not enough button images."); } System.arraycopy(images, 0, this.images, 0, images.length); setCursor(Input.CURSOR_HAND); } /** @return true if this button is a toggle button, false otherwise */ public boolean isToggleButton() { return isToggleButton; } /** Gets a copy of the key bindings for this button. A button has no key bindings by default. @return the key bindings for this button, or null if there are no key bindings. @see #setKeyBinding(int) @see #setKeyBinding(int[]) @see #clearKeyBinding() */ public int[] getKeyBinding() { return CoreSystem.arraycopy(keyBinding); } /** Clears the key binding for this button. @see #getKeyBinding() @see #setKeyBinding(int) @see #setKeyBinding(int[]) */ public void clearKeyBinding() { keyBinding = null; } /** Sets the key binding for this button to the specified key code. The button is considered "clicked" if that key is pressed and released. @see #getKeyBinding() @see #setKeyBinding(int[]) @see #clearKeyBinding() */ public void setKeyBinding(int keyCode) { setKeyBinding(new int[] { keyCode }); } /** Sets the key binding for this button to the specified key codes. The button is considered "clicked" if any of those keys are pressed and released. @see #getKeyBinding() @see #setKeyBinding(int) @see #clearKeyBinding() */ public void setKeyBinding(int[] keyCodes) { keyBinding = CoreSystem.arraycopy(keyCodes); } /** Sets whether this button is selected. For toggle buttons only. */ public void setSelected(boolean isSelected) { if (this.isSelected != isSelected) { this.isSelected = isSelected; // update the frame setState(state); setDirty(true); } } /** Determines if this button is selected. For toggle buttons only. */ public boolean isSelected() { return isSelected; } private void setState(int state) { this.state = state; int frame; if (!isEnabledAndVisible() || state == PRESSED_BUT_OUTSIDE) { frame = NORMAL; } else { frame = state; } if (isToggleButton && isSelected) { frame += NUM_VISIBLE_STATES; } if (images != null) { super.setImage(images[frame]); } } public void update(int elapsedTime) { super.update(elapsedTime); boolean imageChanged = false; for (int i = 0; i < images.length; i++) { imageChanged |= images[i].update(elapsedTime); } if (imageChanged) { setDirty(true); } isClicked = isClickedImpl(); if (state == PRESSED) { rootWhenPressed = getRoot(); } } /** Determines if this button was clicked since the last frame. @return true if this button was clicked since the last frame. */ public boolean isClicked() { return isClicked && getRoot() == rootWhenPressed; } /** Determines if this button was pressed and the mouse is still held down over the button. This method continues to returns true as long as the mouse is pressed and still over the button.

To detect a click, use {@link #isClicked()}.