org.apache.pivot.wtk.skin.terra

Class TerraSuggestionPopupSkin

java.lang.Object

org.apache.pivot.wtk.skin.ComponentSkin

org.apache.pivot.wtk.skin.ContainerSkin

org.apache.pivot.wtk.skin.WindowSkin

org.apache.pivot.wtk.skin.terra.TerraSuggestionPopupSkin

All Implemented Interfaces:

ComponentKeyListener, ComponentListener, ComponentMouseButtonListener, ComponentMouseListener, ComponentMouseWheelListener, ComponentStateListener, ComponentTooltipListener, ConstrainedVisual, ContainerListener, ContainerMouseListener, Skin, SuggestionPopupCloseListener, SuggestionPopupListener, SuggestionPopupSelectionListener, SuggestionPopupStateListener, Visual, Window.Skin, WindowListener, WindowStateListener

public class TerraSuggestionPopupSkin
extends WindowSkin
implements SuggestionPopupListener, SuggestionPopupSelectionListener, SuggestionPopupStateListener

Terra suggestion popup skin.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.pivot.wtk.skin.WindowSkin

WindowSkin.WindowFocusTraversalPolicy

Nested classes/interfaces inherited from class org.apache.pivot.wtk.skin.ContainerSkin

ContainerSkin.IndexFocusTraversalPolicy

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

SuggestionPopupListener.Adapter

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

SuggestionPopupSelectionListener.Adapter

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

SuggestionPopupStateListener.Adapter

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

WindowListener.Adapter

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

WindowStateListener.Adapter

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

ContainerListener.Adapter

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

ContainerMouseListener.Adapter

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

ComponentListener.Adapter

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

ComponentStateListener.Adapter

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

ComponentMouseListener.Adapter

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

ComponentMouseButtonListener.Adapter

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

ComponentKeyListener.Adapter

Constructor Summary

Constructors

Constructor and Description
TerraSuggestionPopupSkin()

Method Summary

Methods

Modifier and Type	Method and Description
Color	getBorderColor()
int	getCloseTransitionDuration()
int	getCloseTransitionRate()
Color	getColor()
Font	getFont()
void	install(Component component) Associates a skin with a component.
boolean	keyPressed(Component component, int keyCode, Keyboard.KeyLocation keyLocation) ENTER Close the suggestion popup with a 'result' of true.
void	listSizeChanged(SuggestionPopup suggestionPopup, int previousListSize) Called when a suggestion popup's list size has changed.
boolean	mouseClick(Component component, Mouse.Button button, int x, int y, int count) Called when a mouse button is clicked over a component.
Vote	previewSuggestionPopupClose(SuggestionPopup suggestionPopup, boolean result) Called to preview a suggestion popup close event.
void	selectedIndexChanged(SuggestionPopup suggestionPopup, int previousSelectedIndex) Called when a suggestion popup's selected index has changed.
void	selectedSuggestionChanged(SuggestionPopup suggestionPopup, Object previousSelectedSuggestion) Called when a suggestion popup's selected suggestion has changed.
void	setBorderColor(Color borderColor)
void	setBorderColor(String borderColor)
void	setCloseTransitionDuration(int closeTransitionDuration)
void	setCloseTransitionRate(int closeTransitionRate)
void	setColor(Color color)
void	setColor(String color)
void	setFont(Dictionary<String,?> font)
void	setFont(Font font)
void	setFont(String font)
void	suggestionDataChanged(SuggestionPopup suggestionPopup, List<?> previousSuggestionData) Called when a suggestion popup's suggestions have changed.
void	suggestionPopupClosed(SuggestionPopup suggestionPopup) Called when a suggestion popup has closed.
void	suggestionPopupCloseVetoed(SuggestionPopup suggestionPopup, Vote reason) Called when a suggestion popup close event has been vetoed.
void	suggestionRendererChanged(SuggestionPopup suggestionPopup, ListView.ItemRenderer previousSuggestionRenderer) Called when a suggestion popup's item renderer has changed.
void	windowClosed(Window window, Display display, Window owner) Called when a window has closed.
void	windowCloseVetoed(Window window, Vote reason) Called when a window close event has been vetoed.
void	windowOpened(Window window) Called when a window has opened.

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

activeChanged, contentChanged, getClientArea, getPreferredHeight, getPreferredSize, getPreferredWidth, iconAdded, iconInserted, iconsRemoved, layout, maximizedChanged, mouseDown, previewWindowClose, previewWindowOpen, titleChanged, windowOpenVetoed

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

componentInserted, componentMoved, componentsRemoved, focusTraversalPolicyChanged, getBackgroundColor, getBackgroundPaint, isFocusable, isOpaque, mouseMove, mouseUp, mouseWheel, paint, setBackgroundColor, setBackgroundColor, setBackgroundPaint, setBackgroundPaint, setBackgroundPaint

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

cursorChanged, decodeFont, dragSourceChanged, dropTargetChanged, enabledChanged, focusedChanged, getBaseline, getBaseline, getComponent, getHeight, getWidth, heightLimitsChanged, invalidateComponent, keyReleased, keyTyped, locationChanged, menuHandlerChanged, mouseDown, mouseMove, mouseOut, mouseOver, mouseUp, mouseWheel, nameChanged, parentChanged, preferredSizeChanged, repaintComponent, repaintComponent, repaintComponent, repaintComponent, repaintComponent, setSize, sizeChanged, 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.Skin

getComponent, isFocusable, isOpaque

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

getBaseline, setSize

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

getBaseline, getHeight, getWidth, paint

Constructor Detail

TerraSuggestionPopupSkin

public TerraSuggestionPopupSkin()

Method Detail

install

public void install(Component component)

Description copied from interface: Skin

Associates a skin with a component.

Specified by:

install in interface Skin

Overrides:

install in class WindowSkin

Parameters:

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

getFont

public Font getFont()

setFont

public void setFont(Font font)

setFont

public final void setFont(String font)

setFont

public final void setFont(Dictionary<String,?> font)

getColor

public Color getColor()

setColor

public void setColor(Color color)

setColor

public final void setColor(String color)

getBorderColor

public Color getBorderColor()

setBorderColor

public void setBorderColor(Color borderColor)

setBorderColor

public final void setBorderColor(String borderColor)

getCloseTransitionDuration

public int getCloseTransitionDuration()

setCloseTransitionDuration

public void setCloseTransitionDuration(int closeTransitionDuration)

getCloseTransitionRate

public int getCloseTransitionRate()

setCloseTransitionRate

public void setCloseTransitionRate(int closeTransitionRate)

mouseClick

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

Description copied from interface: ComponentMouseButtonListener

Called when a mouse button is clicked over a component.

Specified by:

mouseClick in interface ComponentMouseButtonListener

Overrides:

mouseClick in class ComponentSkin

Returns:

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

keyPressed

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

ENTER Close the suggestion popup with a 'result' of true.
ESCAPE Close the suggestion popup with a 'result' of false.

Specified by:

keyPressed in interface ComponentKeyListener

Overrides:

keyPressed in class ComponentSkin

Returns:

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

windowOpened

public void windowOpened(Window window)

Description copied from interface: WindowStateListener

Called when a window has opened.

Specified by:

windowOpened in interface WindowStateListener

Overrides:

windowOpened in class WindowSkin

windowCloseVetoed

public void windowCloseVetoed(Window window,
                     Vote reason)

Description copied from interface: WindowStateListener

Called when a window close event has been vetoed.

Specified by:

windowCloseVetoed in interface WindowStateListener

Overrides:

windowCloseVetoed in class WindowSkin

windowClosed

public void windowClosed(Window window,
                Display display,
                Window owner)

Description copied from interface: WindowStateListener

Called when a window has closed.

Specified by:

windowClosed in interface WindowStateListener

Overrides:

windowClosed in class WindowSkin

suggestionDataChanged

public void suggestionDataChanged(SuggestionPopup suggestionPopup,
                         List<?> previousSuggestionData)

Description copied from interface: SuggestionPopupListener

Called when a suggestion popup's suggestions have changed.

Specified by:

suggestionDataChanged in interface SuggestionPopupListener

suggestionRendererChanged

public void suggestionRendererChanged(SuggestionPopup suggestionPopup,
                             ListView.ItemRenderer previousSuggestionRenderer)

Description copied from interface: SuggestionPopupListener

Called when a suggestion popup's item renderer has changed.

Specified by:

suggestionRendererChanged in interface SuggestionPopupListener

listSizeChanged

public void listSizeChanged(SuggestionPopup suggestionPopup,
                   int previousListSize)

Description copied from interface: SuggestionPopupListener

Called when a suggestion popup's list size has changed.

Specified by:

listSizeChanged in interface SuggestionPopupListener

selectedIndexChanged

public void selectedIndexChanged(SuggestionPopup suggestionPopup,
                        int previousSelectedIndex)

Description copied from interface: SuggestionPopupSelectionListener

Called when a suggestion popup's selected index has changed.

Specified by:

selectedIndexChanged in interface SuggestionPopupSelectionListener

selectedSuggestionChanged

public void selectedSuggestionChanged(SuggestionPopup suggestionPopup,
                             Object previousSelectedSuggestion)

Description copied from interface: SuggestionPopupSelectionListener

Called when a suggestion popup's selected suggestion has changed.

Specified by:

selectedSuggestionChanged in interface SuggestionPopupSelectionListener

Parameters:

suggestionPopup - The source of the event.

previousSelectedSuggestion - The item that was previously selected, or null if the previous selection cannot be determined.

previewSuggestionPopupClose

public Vote previewSuggestionPopupClose(SuggestionPopup suggestionPopup,
                               boolean result)

Description copied from interface: SuggestionPopupStateListener

Called to preview a suggestion popup close event.

Specified by:

previewSuggestionPopupClose in interface SuggestionPopupStateListener

suggestionPopupCloseVetoed

public void suggestionPopupCloseVetoed(SuggestionPopup suggestionPopup,
                              Vote reason)

Description copied from interface: SuggestionPopupStateListener

Called when a suggestion popup close event has been vetoed.

Specified by:

suggestionPopupCloseVetoed in interface SuggestionPopupStateListener

suggestionPopupClosed

public void suggestionPopupClosed(SuggestionPopup suggestionPopup)

Description copied from interface: SuggestionPopupCloseListener

Called when a suggestion popup has closed.

Specified by:

suggestionPopupClosed in interface SuggestionPopupCloseListener