Package org.apache.pivot.wtk.skin

Class ContainerSkin

    • Constructor Detail

      • ContainerSkin

        public ContainerSkin()

    • 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 ComponentSkin
        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
        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
        Parameters:
        width - The width by which to constrain the preferred height, or -1 for no constraint.
        Returns:
        The preferred height given the width constraint.

      • paint

        public void paint​(java.awt.Graphics2D graphics)
        Description copied from interface: Visual
        Paints the visual.
        Specified by:
        paint in interface Visual
        Parameters:
        graphics - The graphics context in which to paint the visual.

      • isFocusable

        public boolean isFocusable()
        Description copied from class: ComponentSkin
        By default, skins are focusable.
        Specified by:
        isFocusable in interface Skin
        Overrides:
        isFocusable in class ComponentSkin
        Returns:
        false; by default, containers are not focusable.

      • isOpaque

        public boolean isOpaque()
        Description copied from class: ComponentSkin
        By default, skins are assumed to be opaque.
        Specified by:
        isOpaque in interface Skin
        Overrides:
        isOpaque in class ComponentSkin
        Returns:
        true if this skin is opaque; false if any part of it is transparent or translucent.

      • getBackgroundPaint

        public java.awt.Paint getBackgroundPaint()
        Returns:
        The Paint object used to paint the background of the container.

      • setBackgroundPaint

        public void setBackgroundPaint​(java.awt.Paint newBackgroundPaint)
        Sets the object used to paint the background of the container.
        Parameters:
        newBackgroundPaint - The new Paint object to paint the background.

      • setBackgroundPaint

        public final void setBackgroundPaint​(java.lang.String backgroundPaintString)
        Sets the object used to paint the background of the container.
        Parameters:
        backgroundPaintString - A string recognized by Pivot as a Color or Paint value.

      • setBackgroundPaint

        public final void setBackgroundPaint​(Dictionary<java.lang.String,​?> backgroundPaintDictionary)
        Sets the object used to paint the background of the container.
        Parameters:
        backgroundPaintDictionary - A dictionary containing a Paint description.

      • getBackgroundColor

        public java.awt.Color getBackgroundColor()
        Returns:
        The color of the container's background if a solid color has been set as the background; otherwise null.

      • setBackgroundColor

        public void setBackgroundColor​(java.awt.Color backgroundColor)
        Sets the background of the container to a solid color.
        Parameters:
        backgroundColor - The new background color for the container.

      • setBackgroundColor

        public final void setBackgroundColor​(java.lang.String backgroundColorString)
        Sets the background of the container to a solid color.
        Parameters:
        backgroundColorString - Any of the color values recognized by Pivot.

      • setBackgroundColor

        public final void setBackgroundColor​(int backgroundColorIndex)
        Sets the background of the container to one of the theme colors.
        Parameters:
        backgroundColorIndex - An index into the theme's color palette.

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

      • componentMoved

        public void componentMoved​(Container container,
                           int from,
                           int to)
        Description copied from interface: ContainerListener
        Called when a component has moved from one z-index to another within a container.
        Specified by:
        componentMoved in interface ContainerListener
        Parameters:
        container - The container that has changed.
        from - The starting index of the component (in Z-order).
        to - The place in the Z-order where this component ended up.

      • focusTraversalPolicyChanged

        public void focusTraversalPolicyChanged​(Container container,
                                        FocusTraversalPolicy previousFocusTraversalPolicy)
        Description copied from interface: ContainerListener
        Called when a container's focus traversal policy has changed.
        Specified by:
        focusTraversalPolicyChanged in interface ContainerListener
        Parameters:
        container - The container that has changed.
        previousFocusTraversalPolicy - The previous value of the focus traversal policy for this container.

      • mouseMove

        public boolean mouseMove​(Container container,
                         int x,
                         int y)
        Description copied from interface: ContainerMouseListener
        Called when the mouse is moved over a container.
        Specified by:
        mouseMove in interface ContainerMouseListener
        Parameters:
        container - The container under the mouse.
        x - The X-position of the mouse.
        y - The Y-position of the mouse.
        Returns:
        true to consume the event; false to allow it to propagate.

      • mouseDown

        public boolean mouseDown​(Container container,
                         Mouse.Button button,
                         int x,
                         int y)
        Description copied from interface: ContainerMouseListener
        Called when the mouse is pressed over a container.
        Specified by:
        mouseDown in interface ContainerMouseListener
        Parameters:
        container - The container under the mouse.
        button - Which button was pressed.
        x - The X-position of the mouse.
        y - The Y-position of the mouse.
        Returns:
        true to consume the event; false to allow it to propagate.

      • mouseUp

        public boolean mouseUp​(Container container,
                       Mouse.Button button,
                       int x,
                       int y)
        Description copied from interface: ContainerMouseListener
        Called when the mouse is released over a container.
        Specified by:
        mouseUp in interface ContainerMouseListener
        Parameters:
        container - The container under the mouse.
        button - Which mouse button was released.
        x - The X-position at the time of release.
        y - The Y-position at the time of release.
        Returns:
        true to consume the event; false to allow it to propagate.

      • mouseWheel

        public boolean mouseWheel​(Container container,
                          Mouse.ScrollType scrollType,
                          int scrollAmount,
                          int wheelRotation,
                          int x,
                          int y)
        Description copied from interface: ContainerMouseListener
        Called when the mouse wheel is scrolled over a container.
        Specified by:
        mouseWheel in interface ContainerMouseListener
        Parameters:
        container - The container under the mouse.
        scrollType - Which type of scroll happened.
        scrollAmount - How much scrolling was requested.
        wheelRotation - The amount and direction of wheel rotation.
        x - The X-position of the mouse at the time.
        y - The Y-position of the mouse.
        Returns:
        true to consume the event; false to allow it to propagate.