Package org.apache.pivot.wtk

Interface ContainerMouseListener

All Known Implementing Classes:

BorderSkin, BoxPaneSkin, CalendarSkin, CardPaneSkin, ColorChooserButtonSkin.ColorChooserPopupSkin, ColorChooserSkin, ContainerMouseListener.Adapter, ContainerMouseListener.Listeners, ContainerSkin, DisplaySkin, ExpanderSkin, FileBrowserSkin, FillPaneSkin, FlowPaneSkin, GridPaneSkin, PanelSkin, RollupSkin, ScrollPaneSkin, SliderSkin, StackPaneSkin, TablePaneSkin, TabPaneSkin, TerraAccordionSkin, TerraAlertSkin, TerraBorderSkin, TerraCalendarSkin, TerraColorChooserSkin, TerraDialogSkin, TerraExpanderSkin, TerraFileBrowserSheetSkin, TerraFileBrowserSkin, TerraFormSkin, TerraFrameSkin, TerraGridPaneSkin, TerraMenuBarSkin, TerraMenuPopupSkin, TerraMenuSkin, TerraPaletteSkin, TerraPanoramaSkin, TerraPromptSkin, TerraRollupSkin, TerraScrollBarSkin, TerraScrollPaneSkin, TerraSheetSkin, TerraSliderSkin, TerraSpinnerSkin, TerraSplitPaneSkin, TerraSuggestionPopupSkin, TerraTablePaneSkin, TerraTabPaneSkin, TerraTextPaneSkin, TerraTooltipSkin, TerraVFSBrowserSheetSkin, TerraVFSBrowserSkin, TextPaneSkin, VFSBrowserSkin, WindowSkin

public interface ContainerMouseListener

Container mouse listener interface. Container mouse events are "tunneling" events that are fired as the event propagates down the component hierarchy.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ContainerMouseListener.Adapter	Deprecated. Since 2.1 and Java 8 the interface itself has default implementations.
static class	ContainerMouseListener.Listeners	Container mouse listeners.

Method Summary

Modifier and Type	Method	Description
default boolean	mouseDown(Container container, Mouse.Button button, int x, int y)	Called when the mouse is pressed over a container.
default boolean	mouseMove(Container container, int x, int y)	Called when the mouse is moved over a container.
default boolean	mouseUp(Container container, Mouse.Button button, int x, int y)	Called when the mouse is released over a container.
default boolean	mouseWheel(Container container, Mouse.ScrollType scrollType, int scrollAmount, int wheelRotation, int x, int y)	Called when the mouse wheel is scrolled over a container.

Method Detail

mouseMove

default boolean mouseMove(Container container,
                          int x,
                          int y)

Called when the mouse is moved over a container.

Parameters:

container - The container under the mouse.

x - The X-position of the mouse.

y - The Y-position of the mouse.

Returns:

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

mouseDown

default boolean mouseDown(Container container,
                          Mouse.Button button,
                          int x,
                          int y)

Called when the mouse is pressed over a container.

Parameters:

container - The container under the mouse.

button - Which button was pressed.

x - The X-position of the mouse.

y - The Y-position of the mouse.

Returns:

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

mouseUp

default boolean mouseUp(Container container,
                        Mouse.Button button,
                        int x,
                        int y)

Called when the mouse is released over a container.

Parameters:

container - The container under the mouse.

button - Which mouse button was released.

x - The X-position at the time of release.

y - The Y-position at the time of release.

Returns:

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

mouseWheel

default boolean mouseWheel(Container container,
                           Mouse.ScrollType scrollType,
                           int scrollAmount,
                           int wheelRotation,
                           int x,
                           int y)

Called when the mouse wheel is scrolled over a container.

Parameters:

container - The container under the mouse.

scrollType - Which type of scroll happened.

scrollAmount - How much scrolling was requested.

wheelRotation - The amount and direction of wheel rotation.

x - The X-position of the mouse at the time.

y - The Y-position of the mouse.

Returns:

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