Package org.apache.pivot.wtk.skin.terra

Class TerraSheetSkin

    • Constructor Detail

      • TerraSheetSkin

        public TerraSheetSkin()

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

      • 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
        Overrides:
        layout in class WindowSkin

      • paint

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

      • sizeChanged

        public void sizeChanged​(Component component,
                        int previousWidth,
                        int previousHeight)
        Description copied from interface: ComponentListener
        Called when a component's size has changed.
        Specified by:
        sizeChanged in interface ComponentListener
        Overrides:
        sizeChanged in class ComponentSkin
        Parameters:
        component - Component that changed size.
        previousWidth - Previous width of this component.
        previousHeight - Previous height of this component.

      • mouseMove

        public boolean mouseMove​(Component component,
                         int x,
                         int y)
        Description copied from interface: ComponentMouseListener
        Called when the mouse is moved over a component.
        Specified by:
        mouseMove in interface ComponentMouseListener
        Overrides:
        mouseMove in class ComponentSkin
        Parameters:
        component - Component that is under the mouse.
        x - X position of the mouse.
        y - Y position of the mouse.
        Returns:
        true to consume the event; false to allow it to propagate (default return).

      • 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
        Overrides:
        mouseDown in class WindowSkin
        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​(Component component,
                       Mouse.Button button,
                       int x,
                       int y)
        Description copied from interface: ComponentMouseButtonListener
        Called when a mouse button is released over a component.
        Specified by:
        mouseUp in interface ComponentMouseButtonListener
        Overrides:
        mouseUp in class ComponentSkin
        Parameters:
        component - Component user the mouse pointer.
        button - Which mouse button that was released.
        x - X position of the mouse.
        y - Y position of the mouse.
        Returns:
        true to consume the event; false to allow it to propagate (default).

      • keyPressed

        public boolean keyPressed​(Component component,
                          int keyCode,
                          Keyboard.KeyLocation keyLocation)
        ENTER Close the sheet with a 'result' of true.
        ESCAPE Close the sheet with a 'result' of false.
        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.

      • setBackgroundColor

        public void setBackgroundColor​(java.awt.Color backgroundColor)
        Description copied from class: ContainerSkin
        Sets the background of the container to a solid color.
        Overrides:
        setBackgroundColor in class ContainerSkin
        Parameters:
        backgroundColor - The new background color for the container.

      • getBorderColor

        public java.awt.Color getBorderColor()

      • setBorderColor

        public void setBorderColor​(java.awt.Color borderColor)

      • setBorderColor

        public final void setBorderColor​(java.lang.String borderColor)

      • getPadding

        public Insets getPadding()

      • setPadding

        public void setPadding​(Insets padding)

      • setPadding

        public final void setPadding​(Dictionary<java.lang.String,​?> padding)

      • setPadding

        public final void setPadding​(Sequence<?> padding)

      • setPadding

        public final void setPadding​(int padding)

      • setPadding

        public final void setPadding​(java.lang.Number padding)

      • setPadding

        public final void setPadding​(java.lang.String padding)

      • isResizable

        public boolean isResizable()

      • setResizable

        public void setResizable​(boolean resizable)

      • getStateTransitionDuration

        public int getStateTransitionDuration()

      • setStateTransitionDuration

        public void setStateTransitionDuration​(int stateTransitionDuration)

      • getStateTransitionRate

        public int getStateTransitionRate()

      • setStateTransitionRate

        public void setStateTransitionRate​(int stateTransitionRate)

      • previewSheetClose

        public Vote previewSheetClose​(Sheet sheet,
                              boolean result)
        Description copied from interface: SheetStateListener
        Called to preview a sheet close event.
        Specified by:
        previewSheetClose in interface SheetStateListener
        Parameters:
        sheet - The source of the event.
        result - The proposed result of the close.
        Returns:
        What this listener wants to decide about this proposed close.

      • sheetCloseVetoed

        public void sheetCloseVetoed​(Sheet sheet,
                             Vote reason)
        Description copied from interface: SheetStateListener
        Called when a sheet close event has been vetoed.
        Specified by:
        sheetCloseVetoed in interface SheetStateListener
        Parameters:
        sheet - The close event source.
        reason - The accumulated vote that resulted in the veto.

      • alignToOwner

        public void alignToOwner()