Package org.apache.pivot.wtk

Interface ComponentKeyListener

All Known Implementing Classes:

ActivityIndicatorSkin, BorderSkin, BoxPaneSkin, ButtonSkin, CalendarButtonSkin, CalendarSkin, CardPaneSkin, ChartViewSkin, CheckboxSkin, ColorChooserButtonSkin, ColorChooserButtonSkin.ColorChooserPopupSkin, ColorChooserSkin, ComponentKeyListener.Adapter, ComponentKeyListener.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 ComponentKeyListener

Component key listener interface.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
default boolean	keyPressed(Component component, int keyCode, Keyboard.KeyLocation keyLocation)	Called when a key has been pressed.
default boolean	keyReleased(Component component, int keyCode, Keyboard.KeyLocation keyLocation)	Called when a key has been released.
default boolean	keyTyped(Component component, char character)	Called when a key has been typed.

Method Detail

keyTyped

default boolean keyTyped(Component component,
                         char character)

Called when a key has been typed.

Parameters:

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

character - The decoded character that was typed.

Returns:

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

keyPressed

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

Called when a key has been pressed.

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.

keyReleased

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

Called when a key has been released.

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.