org.apache.pivot.wtk
Interface ContainerMouseListener

All Known Implementing Classes:
BorderSkin, BoxPaneSkin, CalendarSkin, CardPaneSkin, ColorChooserButtonSkin.ColorChooserPopupSkin, ColorChooserSkin, ContainerMouseListener.Adapter, ContainerSkin, DisplaySkin, ExpanderSkin, FileBrowserSkin, FillPaneSkin, FlowPaneSkin, GridPaneSkin, PanelSkin, RollupSkin, ScrollPaneSkin, SliderSkin, StackPaneSkin, TablePaneSkin, TabPaneSkin, TerraAccordionSkin, TerraAlertSkin, TerraBorderSkin, TerraBoxPaneSkin, TerraCalendarSkin, TerraColorChooserSkin, TerraDialogSkin, TerraExpanderSkin, TerraFileBrowserSheetSkin, TerraFileBrowserSkin, TerraFillPaneSkin, TerraFormSkin, TerraFrameSkin, TerraGridPaneSkin, TerraMenuBarSkin, TerraMenuPopupSkin, TerraMenuSkin, TerraPaletteSkin, TerraPanelSkin, TerraPanoramaSkin, TerraPromptSkin, TerraRollupSkin, TerraScrollBarSkin, TerraScrollPaneSkin, TerraSheetSkin, TerraSliderSkin, TerraSpinnerSkin, TerraSplitPaneSkin, TerraSuggestionPopupSkin, TerraTablePaneSkin, TerraTabPaneSkin, TerraTextPaneSkin, TerraTooltipSkin, TextPaneSkin, 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
static class ContainerMouseListener.Adapter
          Container mouse listener adapter.
 
Method Summary
 boolean mouseDown(Container container, Mouse.Button button, int x, int y)
          Called when the mouse is pressed over a container.
 boolean mouseMove(Container container, int x, int y)
          Called when the mouse is moved over a container.
 boolean mouseUp(Container container, Mouse.Button button, int x, int y)
          Called when the mouse is released over a container.
 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

boolean mouseMove(Container container,
                  int x,
                  int y)
Called when the mouse is moved over a container.

Parameters:
container -
x -
y -
Returns:
true to consume the event; false to allow it to propagate.

mouseDown

boolean mouseDown(Container container,
                  Mouse.Button button,
                  int x,
                  int y)
Called when the mouse is pressed over a container.

Parameters:
container -
button -
x -
y -
Returns:
true to consume the event; false to allow it to propagate.

mouseUp

boolean mouseUp(Container container,
                Mouse.Button button,
                int x,
                int y)
Called when the mouse is released over a container.

Parameters:
container -
button -
x -
y -
Returns:
true to consume the event; false to allow it to propagate.

mouseWheel

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 -
scrollType -
scrollAmount -
wheelRotation -
x -
y -
Returns:
true to consume the event; false to allow it to propagate.