Package org.apache.pivot.wtk

Interface ComponentMouseButtonListener

All Known Implementing Classes:

ActivityIndicatorSkin, BorderSkin, BoxPaneSkin, ButtonSkin, CalendarButtonSkin, CalendarSkin, CardPaneSkin, ChartViewSkin, CheckboxSkin, ColorChooserButtonSkin, ColorChooserButtonSkin.ColorChooserPopupSkin, ColorChooserSkin, ComponentMouseButtonListener.Adapter, ComponentMouseButtonListener.Listeners, ComponentSkin, ContainerSkin, DisplaySkin, ExpanderSkin, FileBrowserSkin, FillPaneSkin, FlowPaneSkin, GridPaneFillerSkin, GridPaneSkin, ImageViewSkin, LabelSkin, LinkButtonSkin, ListButtonSkin, MenuBarItemSkin, MenuButtonSkin, MenuItemSkin, MovieViewSkin, NumberRulerSkin, PanelSkin, PushButtonSkin, RadioButtonSkin, RollupSkin, RulerSkin, ScrollPaneSkin, SeparatorSkin, SliderSkin, StackPaneSkin, TablePaneFillerSkin, TablePaneSkin, TabPaneSkin, TerraAccordionSkin, TerraAccordionSkin.PanelHeaderSkin, TerraActivityIndicatorSkin, TerraAlertSkin, TerraBorderSkin, TerraCalendarButtonSkin, TerraCalendarSkin, TerraCalendarSkin.DateButtonSkin, TerraCheckboxSkin, TerraColorChooserButtonSkin, TerraColorChooserSkin, TerraDialogSkin, TerraExpanderSkin, TerraExpanderSkin.ShadeButtonSkin, TerraFileBrowserSheetSkin, TerraFileBrowserSkin, TerraFormSkin, TerraFrameSkin, TerraFrameSkin.FrameButtonSkin, TerraGaugeSkin, TerraGridPaneSkin, TerraLabelSkin, TerraLinkButtonSkin, TerraListButtonSkin, TerraListViewSkin, TerraMenuBarItemSkin, TerraMenuBarSkin, TerraMenuButtonSkin, TerraMenuItemSkin, TerraMenuPopupSkin, TerraMenuSkin, TerraMeterSkin, TerraPaletteSkin, TerraPanoramaSkin, TerraPanoramaSkin.ScrollButtonSkin, TerraPromptSkin, TerraPushButtonSkin, TerraRadioButtonSkin, TerraRollupSkin, TerraRollupSkin.RollupButtonSkin, TerraScrollBarSkin, TerraScrollBarSkin.HandleSkin, TerraScrollBarSkin.ScrollButtonSkin, TerraScrollPaneCornerSkin, TerraScrollPaneSkin, TerraSeparatorSkin, TerraSheetSkin, TerraSliderSkin, TerraSliderSkin.ThumbSkin, TerraSpinnerSkin, TerraSpinnerSkin.SpinButtonSkin, TerraSpinnerSkin.SpinnerContentSkin, TerraSplitPaneSkin, TerraSplitPaneSkin.SplitterShadowSkin, TerraSplitPaneSkin.SplitterSkin, TerraSuggestionPopupSkin, TerraTablePaneSkin, TerraTableViewHeaderSkin, TerraTableViewSkin, TerraTabPaneSkin, TerraTabPaneSkin.TabButtonSkin, TerraTextAreaSkin, TerraTextInputSkin, TerraTextPaneSkin, TerraTooltipSkin, TerraTreeViewSkin, TerraVFSBrowserSheetSkin, TerraVFSBrowserSkin, TextAreaSkin, TextPaneSkin, VFSBrowserSkin, WindowSkin

public interface ComponentMouseButtonListener

Component mouse button listener interface.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
default boolean	mouseClick(Component component, Mouse.Button button, int x, int y, int count)	Called when a mouse button is clicked over a component.
default boolean	mouseDown(Component component, Mouse.Button button, int x, int y)	Called when a mouse button is pressed over a component.
default boolean	mouseUp(Component component, Mouse.Button button, int x, int y)	Called when a mouse button is released over a component.

Method Detail

mouseDown

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

Called when a mouse button is pressed over a component.

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

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

Called when a mouse button is released over a component.

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).

mouseClick

default boolean mouseClick(Component component,
                           Mouse.Button button,
                           int x,
                           int y,
                           int count)

Called when a mouse button is clicked over a component.

Parameters:

component - Component user the mouse pointer.

button - Which mouse button was clicked.

x - X position of the mouse.

y - Y position of the mouse.

count - Number of clicks (1 = single click, 2 = double click, etc.).

Returns:

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