Package org.apache.pivot.wtk.skin

Class MenuButtonSkin

java.lang.Object

org.apache.pivot.wtk.skin.ComponentSkin

org.apache.pivot.wtk.skin.ButtonSkin

org.apache.pivot.wtk.skin.MenuButtonSkin

All Implemented Interfaces:

ButtonListener, ButtonPressListener, ButtonStateListener, ComponentKeyListener, ComponentListener, ComponentMouseButtonListener, ComponentMouseListener, ComponentMouseWheelListener, ComponentStateListener, ComponentTooltipListener, ConstrainedVisual, MenuButton.Skin, MenuButtonListener, Skin, Visual

Direct Known Subclasses:

TerraMenuButtonSkin

public abstract class MenuButtonSkin
extends ButtonSkin
implements MenuButton.Skin, MenuButtonListener

Abstract base class for menu button skins.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.pivot.wtk.ButtonListener

ButtonListener.Adapter, ButtonListener.Listeners

Nested classes/interfaces inherited from interface org.apache.pivot.wtk.ButtonPressListener

ButtonPressListener.Listeners

Nested classes/interfaces inherited from interface org.apache.pivot.wtk.ButtonStateListener

ButtonStateListener.Listeners

Nested classes/interfaces inherited from interface org.apache.pivot.wtk.ComponentKeyListener

ComponentKeyListener.Adapter, ComponentKeyListener.Listeners

Nested classes/interfaces inherited from interface org.apache.pivot.wtk.ComponentListener

ComponentListener.Adapter, ComponentListener.Listeners

Nested classes/interfaces inherited from interface org.apache.pivot.wtk.ComponentMouseButtonListener

ComponentMouseButtonListener.Adapter, ComponentMouseButtonListener.Listeners

Nested classes/interfaces inherited from interface org.apache.pivot.wtk.ComponentMouseListener

ComponentMouseListener.Adapter, ComponentMouseListener.Listeners

Nested classes/interfaces inherited from interface org.apache.pivot.wtk.ComponentMouseWheelListener

ComponentMouseWheelListener.Listeners

Nested classes/interfaces inherited from interface org.apache.pivot.wtk.ComponentStateListener

ComponentStateListener.Adapter, ComponentStateListener.Listeners

Nested classes/interfaces inherited from interface org.apache.pivot.wtk.ComponentTooltipListener

ComponentTooltipListener.Listeners

Nested classes/interfaces inherited from interface org.apache.pivot.wtk.MenuButtonListener

MenuButtonListener.Listeners

Field Summary

Fields

Modifier and Type	Field	Description
protected MenuPopup	menuPopup
protected boolean	pressed

Fields inherited from class org.apache.pivot.wtk.skin.ButtonSkin

highlighted

Constructor Summary

Constructors

Constructor	Description
MenuButtonSkin()

Method Summary

Modifier and Type	Method	Description
void	enabledChanged(Component component)	Called when a component's enabled state has changed.
Window	getMenuPopup()
void	install(Component component)	Must be implemented in every subclass in order to do component-specific operations at instantiation time, but every subclass must call this superclass method to setup the necessary listeners, etc.
boolean	keyPressed(Component component, int keyCode, Keyboard.KeyLocation keyLocation)	SPACE Repaints the component to reflect the pressed state.
boolean	keyReleased(Component component, int keyCode, Keyboard.KeyLocation keyLocation)	SPACE 'presses' the button.
void	menuChanged(MenuButton menuButton, Menu previousMenu)	Called when a menu button's menu has changed.
boolean	mouseDown(Component component, Mouse.Button button, int x, int y)	Called when a mouse button is pressed over a component.
void	mouseOut(Component component)	Called when the mouse exits a component.
boolean	mouseUp(Component component, Mouse.Button button, int x, int y)	Called when a mouse button is released over a component.

Methods inherited from class org.apache.pivot.wtk.skin.ButtonSkin

actionChanged, buttonDataChanged, buttonGroupChanged, buttonPressed, dataRendererChanged, focusedChanged, layout, mouseOver, stateChanged, toggleButtonChanged, triStateChanged

Methods inherited from class org.apache.pivot.wtk.skin.ComponentSkin

colorFromObject, colorFromObject, colorFromObject, colorFromObject, currentTheme, cursorChanged, decodeFont, defaultBackgroundColor, defaultForegroundColor, dragSourceChanged, dropTargetChanged, fontFromObject, getBaseline, getBaseline, getColor, getComponent, getFocusRectangleStroke, getHeight, getPreferredSize, getSize, getTextInputMethodListener, getThemeFont, getWidth, heightLimitsChanged, invalidateComponent, isFocusable, isOpaque, keyTyped, locationChanged, menuHandlerChanged, mouseClick, mouseMove, mouseWheel, nameChanged, parentChanged, preferredSizeChanged, repaintComponent, repaintComponent, repaintComponent, repaintComponent, repaintComponent, setDefaultStyles, setSize, sizeChanged, themeHasThickFocusRectangle, themeHasTransitionEnabled, themeIsDark, themeIsFlat, tooltipDelayChanged, tooltipTextChanged, tooltipTriggered, visibleChanged, widthLimitsChanged

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.pivot.wtk.ConstrainedVisual

getPreferredHeight, getPreferredWidth, setSize

Methods inherited from interface org.apache.pivot.wtk.Visual

paint

Field Detail

pressed

protected boolean pressed

menuPopup

protected MenuPopup menuPopup

Constructor Detail

MenuButtonSkin

public MenuButtonSkin()

Method Detail

install

public void install(Component component)

Description copied from class: ComponentSkin

Must be implemented in every subclass in order to do component-specific operations at instantiation time, but every subclass must call this superclass method to setup the necessary listeners, etc.

Specified by:

install in interface Skin

Overrides:

install in class ButtonSkin

Parameters:

component - The component to which the skin is being attached.

getMenuPopup

public Window getMenuPopup()

Specified by:

getMenuPopup in interface MenuButton.Skin

enabledChanged

public void enabledChanged(Component component)

Description copied from interface: ComponentStateListener

Called when a component's enabled state has changed.

Called both when the component is enabled and when it is disabled. The component's enabled flag has already been set when this method is called so the new state can be determined by calling the Component.isEnabled() method.

Specified by:

enabledChanged in interface ComponentStateListener

Overrides:

enabledChanged in class ButtonSkin

Parameters:

component - The component whose enabled state is changing.

mouseOut

public void mouseOut(Component component)

Description copied from interface: ComponentMouseListener

Called when the mouse exits a component.

Default is to do nothing.

Specified by:

mouseOut in interface ComponentMouseListener

Overrides:

mouseOut in class ButtonSkin

Parameters:

component - Component that has now lost the mouse pointer.

mouseDown

public boolean mouseDown(Component component,
                         Mouse.Button button,
                         int x,
                         int y)

Description copied from interface: ComponentMouseButtonListener

Called when a mouse button is pressed over a component.

Specified by:

mouseDown in interface ComponentMouseButtonListener

Overrides:

mouseDown in class ComponentSkin

Parameters:

component - Component that is under the mouse pointer.

button - Which mouse button was pressed.

x - X position of the mouse.

y - Y position of the mouse.

Returns:

true to consume the event; false to allow it to propagate (default).

mouseUp

public boolean mouseUp(Component component,
                       Mouse.Button button,
                       int x,
                       int y)

Description copied from interface: ComponentMouseButtonListener

Called when a mouse button is released over a component.

Specified by:

mouseUp in interface ComponentMouseButtonListener

Overrides:

mouseUp in class ComponentSkin

Parameters:

component - Component user the mouse pointer.

button - Which mouse button that was released.

x - X position of the mouse.

y - Y position of the mouse.

Returns:

true to consume the event; false to allow it to propagate (default).

keyPressed

public boolean keyPressed(Component component,
                          int keyCode,
                          Keyboard.KeyLocation keyLocation)

SPACE Repaints the component to reflect the pressed state.

Specified by:

keyPressed in interface ComponentKeyListener

Overrides:

keyPressed in class ComponentSkin

Parameters:

component - Component that has the focus.

keyCode - The key code for the key that was pressed.

keyLocation - Location value for the key (left or right for shift keys, etc.).

Returns:

true to consume the event; false to allow it to propagate.

See Also:

keyReleased(Component, int, Keyboard.KeyLocation)

keyReleased

public boolean keyReleased(Component component,
                           int keyCode,
                           Keyboard.KeyLocation keyLocation)

SPACE 'presses' the button.

Specified by:

keyReleased in interface ComponentKeyListener

Overrides:

keyReleased in class ComponentSkin

Parameters:

component - Component that has the focus, that is receiving this key event.

keyCode - Code for the key that was released.

keyLocation - Location of the key.

Returns:

true to consume the event; false to allow it to propagate.

menuChanged

public void menuChanged(MenuButton menuButton,
                        Menu previousMenu)

Description copied from interface: MenuButtonListener

Called when a menu button's menu has changed.

Specified by:

menuChanged in interface MenuButtonListener

Parameters:

menuButton - The menu button that has changed.

previousMenu - The previous menu attached to the button.