Package org.apache.pivot.wtk.skin

Class ScrollPaneSkin

    • Constructor Detail

      • ScrollPaneSkin

        public ScrollPaneSkin()

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

      • mouseWheel

        public boolean mouseWheel​(Component component,
                          Mouse.ScrollType scrollType,
                          int scrollAmount,
                          int wheelRotation,
                          int x,
                          int y)
        Description copied from interface: ComponentMouseWheelListener
        Called when the mouse wheel is scrolled over a component.
        Specified by:
        mouseWheel in interface ComponentMouseWheelListener
        Overrides:
        mouseWheel in class ComponentSkin
        Parameters:
        component - Component under the mouse pointer.
        scrollType - What type of scroll was requested on the mouse.
        scrollAmount - Amount of scrolling.
        wheelRotation - Rotation value.
        x - X position of the mouse.
        y - Y position of the mouse.
        Returns:
        true to consume the event; false to allow it to propagate.

      • keyPressed

        public boolean keyPressed​(Component component,
                          int keyCode,
                          Keyboard.KeyLocation keyLocation)
        Key presses have no effect if the event has already been consumed.

        UP Scroll up a single scroll unit.
        DOWN Scroll down a single scroll unit.
        LEFT Scroll left a single scroll unit.
        RIGHT Scroll right a single scroll unit.
        PAGE_UP Scroll up a single scroll block.
        PAGE_DOWN Scroll down a single scroll block.

        Specified by:
        keyPressed in interface ComponentKeyListener
        Overrides:
        keyPressed in class ComponentSkin
        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.
        See Also:
        ScrollBar.getBlockIncrement(), ScrollBar.getUnitIncrement()

      • 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

      • setBackgroundPaint

        public void setBackgroundPaint​(java.awt.Paint backgroundPaint)
        Description copied from class: ContainerSkin
        Sets the object used to paint the background of the container.
        Overrides:
        setBackgroundPaint in class ContainerSkin
        Parameters:
        backgroundPaint - The new Paint object to paint the background.

      • getHorizontalIncrement

        public int getHorizontalIncrement()

      • setHorizontalIncrement

        public void setHorizontalIncrement​(int horizontalIncrement)

      • getVerticalIncrement

        public int getVerticalIncrement()

      • setVerticalIncrement

        public void setVerticalIncrement​(int verticalIncrement)

      • getHorizontalReveal

        public int getHorizontalReveal()

      • setHorizontalReveal

        public void setHorizontalReveal​(int horizontalReveal)

      • getVerticalReveal

        public int getVerticalReveal()

      • setVerticalReveal

        public void setVerticalReveal​(int verticalReveal)

      • getViewportBounds

        public Bounds getViewportBounds()
        Specified by:
        getViewportBounds in interface Viewport.Skin
        Returns:
        The bounds of the Viewport within the container, for example, in ScrollPaneSkin, this excludes the scrollbars.

      • rowHeaderChanged

        public void rowHeaderChanged​(ScrollPane scrollPane,
                             Component previousRowHeader)
        Description copied from interface: ScrollPaneListener
        Called when the scroll pane's row header changed.
        Specified by:
        rowHeaderChanged in interface ScrollPaneListener
        Parameters:
        scrollPane - The source of the event.
        previousRowHeader - The previous row header for this scroll pane.

      • columnHeaderChanged

        public void columnHeaderChanged​(ScrollPane scrollPane,
                                Component previousColumnHeader)
        Description copied from interface: ScrollPaneListener
        Called when the scroll pane's column header changed.
        Specified by:
        columnHeaderChanged in interface ScrollPaneListener
        Parameters:
        scrollPane - The source of the event.
        previousColumnHeader - The previous column header for this scroll pane.

      • cornerChanged

        public void cornerChanged​(ScrollPane scrollPane,
                          Component previousCorner)
        Description copied from interface: ScrollPaneListener
        Called when the scroll pane's corner component changed.
        Specified by:
        cornerChanged in interface ScrollPaneListener
        Parameters:
        scrollPane - The source of the event.
        previousCorner - The previous corner component.

      • scrollTopChanged

        public void scrollTopChanged​(Viewport viewport,
                             int previousScrollTop)
        Description copied from interface: ViewportListener
        Called when a viewport's scroll top has changed.
        Specified by:
        scrollTopChanged in interface ViewportListener
        Parameters:
        viewport - The viewport that has scrolled.
        previousScrollTop - The previous top scroll position.

      • scrollLeftChanged

        public void scrollLeftChanged​(Viewport viewport,
                              int previousScrollLeft)
        Description copied from interface: ViewportListener
        Called when a viewport's scroll left has changed.
        Specified by:
        scrollLeftChanged in interface ViewportListener
        Parameters:
        viewport - The viewport that has been scrolled.
        previousScrollLeft - The previous left scroll position.

      • viewChanged

        public void viewChanged​(Viewport viewport,
                        Component previousView)
        Description copied from interface: ViewportListener
        Called when a viewport's view component has changed.
        Specified by:
        viewChanged in interface ViewportListener
        Parameters:
        viewport - The viewport whose view has changed.
        previousView - What the view (or the scrollable component) used to be.

      • valueChanged

        public void valueChanged​(ScrollBar scrollBar,
                         int previousValue)
        Description copied from interface: ScrollBarValueListener
        Called when a scroll bar's value has changed.
        Specified by:
        valueChanged in interface ScrollBarValueListener
        Parameters:
        scrollBar - The scroll bar that is changing.
        previousValue - The previous value of this scroll bar.