org.apache.pivot.wtk.skin
Class CardPaneSkin

java.lang.Object
  extended by org.apache.pivot.wtk.skin.ComponentSkin
      extended by org.apache.pivot.wtk.skin.ContainerSkin
          extended by org.apache.pivot.wtk.skin.CardPaneSkin
All Implemented Interfaces:
CardPaneListener, ComponentKeyListener, ComponentListener, ComponentMouseButtonListener, ComponentMouseListener, ComponentMouseWheelListener, ComponentStateListener, ComponentTooltipListener, ConstrainedVisual, ContainerListener, ContainerMouseListener, Skin, Visual

public class CardPaneSkin
extends ContainerSkin
implements CardPaneListener

Card pane skin.


Nested Class Summary
 class CardPaneSkin.CrossfadeTransition
          Class that performs cross-fade selection change transitions.
 class CardPaneSkin.FlipTransition
          Class that performs flip selection change transitions.
static class CardPaneSkin.SelectionChangeEffect
          Defines the supported selection change effects.
 class CardPaneSkin.SelectionChangeTransition
          Abstract base class for selection change transitions.
 class CardPaneSkin.SlideTransition
          Class that performs slide selection change transitions.
 class CardPaneSkin.ZoomTransition
          Class that performs zoom change transitions.
 
Nested classes/interfaces inherited from class org.apache.pivot.wtk.skin.ContainerSkin
ContainerSkin.IndexFocusTraversalPolicy
 
Nested classes/interfaces inherited from interface org.apache.pivot.wtk.CardPaneListener
CardPaneListener.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
CardPaneSkin()
           
 
Method Summary
 void componentInserted(Container container, int index)
          Called when a component has been inserted into a container's component sequence.
 void componentsRemoved(Container container, int index, Sequence<Component> removed)
          Called when components have been removed from a container's component sequence.
 int getBaseline(int width, int height)
          Returns the baseline for a given width and height.
 Insets getPadding()
          Returns the amount of space between the edge of the CardPane and its content.
 int getPreferredHeight(int width)
          Returns the visual's preferred height given the provided width constraint.
 Dimensions getPreferredSize()
          Returns the visual's unconstrained preferred size.
 int getPreferredWidth(int height)
          Returns the visual's preferred width given the provided height constraint.
 int getSelectionChangeDuration()
           
 CardPaneSkin.SelectionChangeEffect getSelectionChangeEffect()
           
 int getSelectionChangeRate()
           
 boolean getSizeToSelection()
           
 void install(Component component)
          Associates a skin with a component.
 boolean isCircular()
          Sets the circular style, which controls the direction of certain transitions (transitions for which a direction makes sense) when looping from the first index of a card pane to the last, or vice versa.
 void layout()
          If the component on which the skin is installed is a container, lays out the container's children.
 Vote previewSelectedIndexChange(CardPane cardPane, int selectedIndex)
          Called to preview a selected index change.
 void selectedIndexChanged(CardPane cardPane, int previousSelectedIndex)
          Called when a card pane's selected index has changed.
 void selectedIndexChangeVetoed(CardPane cardPane, Vote reason)
          Called when a selected index change has been vetoed.
 void setCircular(boolean circular)
          Sets the circular style, which controls the direction of certain transitions (transitions for which a direction makes sense) when looping from the first index of a card pane to the last, or vice versa.
 void setPadding(Dictionary<String,?> padding)
          Sets the amount of space to leave between the edge of the CardPane and its content.
 void setPadding(Insets padding)
          Sets the amount of space to leave between the edge of the CardPane and its content.
 void setPadding(int padding)
          Sets the amount of space to leave between the edge of the CardPane and its content, uniformly on all four edges.
 void setPadding(Number padding)
          Sets the amount of space to leave between the edge of the CardPane and its content, uniformly on all four edges.
 void setPadding(String padding)
          Sets the amount of space to leave between the edge of the CardPane and its content.
 void setSelectionChangeDuration(int selectionChangeDuration)
           
 void setSelectionChangeEffect(CardPaneSkin.SelectionChangeEffect selectionChangeEffect)
           
 void setSelectionChangeRate(int selectionChangeRate)
           
 void setSizeToSelection(boolean sizeToSelection)
           
 
Methods inherited from class org.apache.pivot.wtk.skin.ContainerSkin
componentMoved, focusTraversalPolicyChanged, getBackgroundColor, getBackgroundPaint, isFocusable, isOpaque, mouseDown, 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, getComponent, getHeight, getWidth, heightLimitsChanged, invalidateComponent, keyPressed, keyReleased, keyTyped, locationChanged, menuHandlerChanged, mouseClick, 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
 

Constructor Detail

CardPaneSkin

public CardPaneSkin()
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 ContainerSkin
Parameters:
component - The component to which the skin is being attached.

getPreferredWidth

public int getPreferredWidth(int height)
Description copied from interface: ConstrainedVisual
Returns the visual's preferred width given the provided height constraint.

Specified by:
getPreferredWidth in interface ConstrainedVisual
Overrides:
getPreferredWidth in class ContainerSkin
Parameters:
height - The height by which to constrain the preferred width, or -1 for no constraint.

getPreferredHeight

public int getPreferredHeight(int width)
Description copied from interface: ConstrainedVisual
Returns the visual's preferred height given the provided width constraint.

Specified by:
getPreferredHeight in interface ConstrainedVisual
Overrides:
getPreferredHeight in class ContainerSkin
Parameters:
width - The width by which to constrain the preferred height, or -1 for no constraint.

getPreferredSize

public Dimensions getPreferredSize()
Description copied from interface: ConstrainedVisual
Returns the visual's unconstrained preferred size.

Specified by:
getPreferredSize in interface ConstrainedVisual
Overrides:
getPreferredSize in class ComponentSkin

getBaseline

public int getBaseline(int width,
                       int height)
Description copied from interface: ConstrainedVisual
Returns the baseline for a given width and height.

Specified by:
getBaseline in interface ConstrainedVisual
Overrides:
getBaseline in class ComponentSkin
Returns:
The baseline relative to the origin of this visual, or -1 if this visual does not have a baseline.

layout

public void layout()
Description copied from interface: Skin
If the component on which the skin is installed is a container, lays out the container's children.

Specified by:
layout in interface Skin

getPadding

public Insets getPadding()
Returns the amount of space between the edge of the CardPane and its content.


setPadding

public void setPadding(Insets padding)
Sets the amount of space to leave between the edge of the CardPane and its content.


setPadding

public final void setPadding(Dictionary<String,?> padding)
Sets the amount of space to leave between the edge of the CardPane and its content.

Parameters:
padding - A dictionary with keys in the set {left, top, bottom, right}.

setPadding

public final void setPadding(int padding)
Sets the amount of space to leave between the edge of the CardPane and its content, uniformly on all four edges.


setPadding

public void setPadding(Number padding)
Sets the amount of space to leave between the edge of the CardPane and its content, uniformly on all four edges.


setPadding

public final void setPadding(String padding)
Sets the amount of space to leave between the edge of the CardPane and its content.

Parameters:
padding - A string containing an integer or a JSON dictionary with keys left, top, bottom, and/or right.

getSizeToSelection

public boolean getSizeToSelection()

setSizeToSelection

public void setSizeToSelection(boolean sizeToSelection)

getSelectionChangeEffect

public CardPaneSkin.SelectionChangeEffect getSelectionChangeEffect()

setSelectionChangeEffect

public void setSelectionChangeEffect(CardPaneSkin.SelectionChangeEffect selectionChangeEffect)

getSelectionChangeDuration

public int getSelectionChangeDuration()

setSelectionChangeDuration

public void setSelectionChangeDuration(int selectionChangeDuration)

getSelectionChangeRate

public int getSelectionChangeRate()

setSelectionChangeRate

public void setSelectionChangeRate(int selectionChangeRate)

isCircular

public boolean isCircular()
Sets the circular style, which controls the direction of certain transitions (transitions for which a direction makes sense) when looping from the first index of a card pane to the last, or vice versa. When this style is false (the default), directional transitions will always appear to move forward when transitioning from a lower card index to a higher card index, and vice versa. When this style is true, directional transitions will appear to move forward when transitioning from the last card to the first, and backward when they transition from the first card to the last.

Note: to avoid ambiguity, the circular style will be ignored if the card pane has fewer than three cards.

Returns:
true if directional transitions will be circular; false otherwise

setCircular

public void setCircular(boolean circular)
Sets the circular style, which controls the direction of certain transitions (transitions for which a direction makes sense) when looping from the first index of a card pane to the last, or vice versa. When this style is false (the default), directional transitions will always appear to move forward when transitioning from a lower card index to a higher card index, and vice versa. When this style is true, directional transitions will appear to move forward when transitioning from the last card to the first, and backward when they transition from the first card to the last.

Note: to avoid ambiguity, the circular style will be ignored if the card pane has fewer than three cards.

Parameters:
circular - true if directional transitions should be circular; false otherwise

componentInserted

public void componentInserted(Container container,
                              int index)
Description copied from interface: ContainerListener
Called when a component has been inserted into a container's component sequence.

Specified by:
componentInserted in interface ContainerListener
Overrides:
componentInserted in class ContainerSkin

componentsRemoved

public void componentsRemoved(Container container,
                              int index,
                              Sequence<Component> removed)
Description copied from interface: ContainerListener
Called when components have been removed from a container's component sequence.

Specified by:
componentsRemoved in interface ContainerListener
Overrides:
componentsRemoved in class ContainerSkin

previewSelectedIndexChange

public Vote previewSelectedIndexChange(CardPane cardPane,
                                       int selectedIndex)
Description copied from interface: CardPaneListener
Called to preview a selected index change.

Specified by:
previewSelectedIndexChange in interface CardPaneListener
Parameters:
cardPane - The source of the event.
selectedIndex - The index that will be selected.

selectedIndexChangeVetoed

public void selectedIndexChangeVetoed(CardPane cardPane,
                                      Vote reason)
Description copied from interface: CardPaneListener
Called when a selected index change has been vetoed.

Specified by:
selectedIndexChangeVetoed in interface CardPaneListener
Parameters:
cardPane - The source of the event.
reason - The reason the event was vetoed.

selectedIndexChanged

public void selectedIndexChanged(CardPane cardPane,
                                 int previousSelectedIndex)
Description copied from interface: CardPaneListener
Called when a card pane's selected index has changed.

Specified by:
selectedIndexChanged in interface CardPaneListener
Parameters:
cardPane - The source of the event.
previousSelectedIndex - If the selection changed directly, contains the index that was previously selected. Otherwise, contains the current selection.