Package org.apache.pivot.wtk.skin

Class CardPaneSkin

    • Constructor Detail

      • CardPaneSkin

        public CardPaneSkin()

    • Method Detail

      • install

        public void install​(Component component)
        Description copied from class: ComponentSkin
        Must be implemented in every subclass in order to do component-specific operations at instantiation time, but every subclass must call this superclass method to setup the necessary listeners, etc.
        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.
        Returns:
        The preferred width given the height 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.
        Returns:
        The preferred height given the width constraint.

      • getBaseline

        public int getBaseline​(int width,
                       int height)
        Description copied from class: ComponentSkin
        Should be implemented in every subclass.

        The default implementation here simply returns -1 (no baseline).

        Specified by:
        getBaseline in interface ConstrainedVisual
        Overrides:
        getBaseline in class ComponentSkin
        Parameters:
        width - Constrained width to compute the baseline for.
        height - Constrained height to compute the baseline for.
        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 final Insets getPadding()
        Returns:
        The amount of space between the edge of the CardPane and its content.

      • setPadding

        public final void setPadding​(Insets padding)
        Sets the amount of space to leave between the edge of the CardPane and its content.
        Parameters:
        padding - The new padding values for all edges.

      • setPadding

        public final void setPadding​(Dictionary<java.lang.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 {top, left, bottom, right}.

      • setPadding

        public final void setPadding​(Sequence<?> padding)
        Sets the amount of space to leave between the edge of the CardPane and its content.
        Parameters:
        padding - A sequence with values in the order [top, left, 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.
        Parameters:
        padding - The new single padding value to use for all edges.

      • setPadding

        public final void setPadding​(java.lang.Number padding)
        Sets the amount of space to leave between the edge of the CardPane and its content, uniformly on all four edges.
        Parameters:
        padding - The new integer value to use for the padding on all edges.

      • setPadding

        public final void setPadding​(java.lang.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 top, left, bottom, and/or right.

      • getSizeToSelection

        public boolean getSizeToSelection()

      • setSizeToSelection

        public void setSizeToSelection​(boolean sizeToSelection)

      • getSelectionChangeDuration

        public int getSelectionChangeDuration()

      • setSelectionChangeDuration

        public void setSelectionChangeDuration​(int selectionChangeDuration)

      • getSelectionChangeRate

        public int getSelectionChangeRate()

      • setSelectionChangeRate

        public void setSelectionChangeRate​(int selectionChangeRate)

      • isCircular

        public boolean isCircular()
        Returns 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
        Parameters:
        container - The container that has changed.
        index - The index where the new component has been inserted.

      • 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
        Parameters:
        container - The container that has changed.
        index - The starting index of the components that were removed.
        removed - The complete sequence of removed components.

      • 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.
        Returns:
        The consensus vote as to whether to allow this change.

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