Module java.desktop
Package javax.swing.plaf.basic

Class BasicToolBarUI

    • Field Detail

      • toolBar

        protected JToolBar toolBar
        The instance of JToolBar.

      • focusedCompIndex

        protected int focusedCompIndex
        The index of the focused component.

      • dockingColor

        protected Color dockingColor
        The background color of the docking border.

      • floatingColor

        protected Color floatingColor
        The background color of the not docking border.

      • dockingBorderColor

        protected Color dockingBorderColor
        The color of the docking border.

      • floatingBorderColor

        protected Color floatingBorderColor
        The color of the not docking border.

      • dockingListener

        protected MouseInputListener dockingListener
        The instance of a MouseInputListener.

      • propertyListener

        protected PropertyChangeListener propertyListener
        The instance of a PropertyChangeListener.

      • toolBarContListener

        protected ContainerListener toolBarContListener
        The instance of a ContainerListener.

      • toolBarFocusListener

        protected FocusListener toolBarFocusListener
        The instance of a FocusListener.

      • constraintBeforeFloating

        protected String constraintBeforeFloating
        The layout before floating.

      • upKey

        @Deprecated
protected KeyStroke upKey
        Deprecated. As of Java 2 platform v1.3.
        As of Java 2 platform v1.3 this previously undocumented field is no longer used. Key bindings are now defined by the LookAndFeel, please refer to the key bindings specification for further details.

      • downKey

        @Deprecated
protected KeyStroke downKey
        Deprecated. As of Java 2 platform v1.3.
        As of Java 2 platform v1.3 this previously undocumented field is no longer used. Key bindings are now defined by the LookAndFeel, please refer to the key bindings specification for further details.

      • leftKey

        @Deprecated
protected KeyStroke leftKey
        Deprecated. As of Java 2 platform v1.3.
        As of Java 2 platform v1.3 this previously undocumented field is no longer used. Key bindings are now defined by the LookAndFeel, please refer to the key bindings specification for further details.

      • rightKey

        @Deprecated
protected KeyStroke rightKey
        Deprecated. As of Java 2 platform v1.3.
        As of Java 2 platform v1.3 this previously undocumented field is no longer used. Key bindings are now defined by the LookAndFeel, please refer to the key bindings specification for further details.

    • Constructor Detail

      • BasicToolBarUI

        public BasicToolBarUI​()

    • Method Detail

      • createUI

        public static ComponentUI createUI​(JComponent c)
        Constructs a new instance of BasicToolBarUI.
        Parameters:
        c - a component
        Returns:
        a new instance of BasicToolBarUI

      • installUI

        public void installUI​(JComponent c)
        Description copied from class: ComponentUI
        Configures the specified component appropriately for the look and feel. This method is invoked when the ComponentUI instance is being installed as the UI delegate on the specified component. This method should completely configure the component for the look and feel, including the following:
        1. Install default property values for color, fonts, borders, icons, opacity, etc. on the component. Whenever possible, property values initialized by the client program should not be overridden.
        2. Install a LayoutManager on the component if necessary.
        3. Create/add any required sub-components to the component.
        4. Create/install event listeners on the component.
        5. Create/install a PropertyChangeListener on the component in order to detect and respond to component property changes appropriately.
        6. Install keyboard UI (mnemonics, traversal, etc.) on the component.
        7. Initialize any appropriate instance data.
        Overrides:
        installUI in class ComponentUI
        Parameters:
        c - the component where this UI delegate is being installed
        See Also:
        ComponentUI.uninstallUI(javax.swing.JComponent), JComponent.setUI(javax.swing.plaf.ComponentUI), JComponent.updateUI()

      • uninstallUI

        public void uninstallUI​(JComponent c)
        Description copied from class: ComponentUI
        Reverses configuration which was done on the specified component during installUI. This method is invoked when this UIComponent instance is being removed as the UI delegate for the specified component. This method should undo the configuration performed in installUI, being careful to leave the JComponent instance in a clean state (no extraneous listeners, look-and-feel-specific property objects, etc.). This should include the following:
        1. Remove any UI-set borders from the component.
        2. Remove any UI-set layout managers on the component.
        3. Remove any UI-added sub-components from the component.
        4. Remove any UI-added event/property listeners from the component.
        5. Remove any UI-installed keyboard UI from the component.
        6. Nullify any allocated instance data objects to allow for GC.
        Overrides:
        uninstallUI in class ComponentUI
        Parameters:
        c - the component from which this UI delegate is being removed; this argument is often ignored, but might be used if the UI object is stateless and shared by multiple components
        See Also:
        ComponentUI.installUI(javax.swing.JComponent), JComponent.updateUI()

      • installDefaults

        protected void installDefaults​()
        Installs default properties.

      • uninstallDefaults

        protected void uninstallDefaults​()
        Uninstalls default properties.

      • installComponents

        protected void installComponents​()
        Registers components.

      • uninstallComponents

        protected void uninstallComponents​()
        Unregisters components.

      • installListeners

        protected void installListeners​()
        Registers listeners.

      • uninstallListeners

        protected void uninstallListeners​()
        Unregisters listeners.

      • installKeyboardActions

        protected void installKeyboardActions​()
        Registers keyboard actions.

      • uninstallKeyboardActions

        protected void uninstallKeyboardActions​()
        Unregisters keyboard actions.

      • navigateFocusedComp

        protected void navigateFocusedComp​(int direction)
        Navigates the focused component.
        Parameters:
        direction - a direction

      • createRolloverBorder

        protected Border createRolloverBorder​()
        Creates a rollover border for toolbar components. The rollover border will be installed if rollover borders are enabled.

        Override this method to provide an alternate rollover border.

        Returns:
        a rollover border for toolbar components
        Since:
        1.4

      • createNonRolloverBorder

        protected Border createNonRolloverBorder​()
        Creates the non rollover border for toolbar components. This border will be installed as the border for components added to the toolbar if rollover borders are not enabled.

        Override this method to provide an alternate rollover border.

        Returns:
        the non rollover border for toolbar components
        Since:
        1.4

      • createFloatingWindow

        protected RootPaneContainer createFloatingWindow​(JToolBar toolbar)
        Creates a window which contains the toolbar after it has been dragged out from its container
        Parameters:
        toolbar - an instance of JToolBar
        Returns:
        a RootPaneContainer object, containing the toolbar
        Since:
        1.4

      • createDragWindow

        protected BasicToolBarUI.DragWindow createDragWindow​(JToolBar toolbar)
        Returns an instance of DragWindow.
        Parameters:
        toolbar - an instance of JToolBar
        Returns:
        an instance of DragWindow

      • isRolloverBorders

        public boolean isRolloverBorders​()
        Returns a flag to determine whether rollover button borders are enabled.
        Returns:
        true if rollover borders are enabled; false otherwise
        Since:
        1.4
        See Also:
        setRolloverBorders(boolean)

      • setRolloverBorders

        public void setRolloverBorders​(boolean rollover)
        Sets the flag for enabling rollover borders on the toolbar and it will also install the appropriate border depending on the state of the flag.
        Parameters:
        rollover - if true, rollover borders are installed. Otherwise non-rollover borders are installed
        Since:
        1.4
        See Also:
        isRolloverBorders()

      • installRolloverBorders

        protected void installRolloverBorders​(JComponent c)
        Installs rollover borders on all the child components of the JComponent.

        This is a convenience method to call setBorderToRollover for each child component.

        Parameters:
        c - container which holds the child components (usually a JToolBar)
        Since:
        1.4
        See Also:
        setBorderToRollover(java.awt.Component)

      • installNonRolloverBorders

        protected void installNonRolloverBorders​(JComponent c)
        Installs non-rollover borders on all the child components of the JComponent. A non-rollover border is the border that is installed on the child component while it is in the toolbar.

        This is a convenience method to call setBorderToNonRollover for each child component.

        Parameters:
        c - container which holds the child components (usually a JToolBar)
        Since:
        1.4
        See Also:
        setBorderToNonRollover(java.awt.Component)

      • installNormalBorders

        protected void installNormalBorders​(JComponent c)
        Installs normal borders on all the child components of the JComponent. A normal border is the original border that was installed on the child component before it was added to the toolbar.

        This is a convenience method to call setBorderNormal for each child component.

        Parameters:
        c - container which holds the child components (usually a JToolBar)
        Since:
        1.4
        See Also:
        setBorderToNonRollover(java.awt.Component)

      • setBorderToRollover

        protected void setBorderToRollover​(Component c)
        Sets the border of the component to have a rollover border which was created by the createRolloverBorder() method.
        Parameters:
        c - component which will have a rollover border installed
        Since:
        1.4
        See Also:
        createRolloverBorder()

      • setBorderToNonRollover

        protected void setBorderToNonRollover​(Component c)
        Sets the border of the component to have a non-rollover border which was created by the createNonRolloverBorder() method.
        Parameters:
        c - component which will have a non-rollover border installed
        Since:
        1.4
        See Also:
        createNonRolloverBorder()

      • setBorderToNormal

        protected void setBorderToNormal​(Component c)
        Sets the border of the component to have a normal border. A normal border is the original border that was installed on the child component before it was added to the toolbar.
        Parameters:
        c - component which will have a normal border re-installed
        Since:
        1.4
        See Also:
        createNonRolloverBorder()

      • setFloatingLocation

        public void setFloatingLocation​(int x,
                                int y)
        Sets the floating location.
        Parameters:
        x - an X coordinate
        y - an Y coordinate

      • isFloating

        public boolean isFloating​()
        Returns true if the JToolBar is floating
        Returns:
        true if the JToolBar is floating

      • setFloating

        public void setFloating​(boolean b,
                        Point p)
        Sets the floating property.
        Parameters:
        b - true if the JToolBar is floating
        p - the position

      • setOrientation

        public void setOrientation​(int orientation)
        Sets the tool bar's orientation.
        Parameters:
        orientation - the new orientation

      • getDockingColor

        public Color getDockingColor​()
        Gets the color displayed when over a docking area
        Returns:
        the color displayed when over a docking area

      • setDockingColor

        public void setDockingColor​(Color c)
        Sets the color displayed when over a docking area
        Parameters:
        c - the new color

      • getFloatingColor

        public Color getFloatingColor​()
        Gets the color displayed when over a floating area
        Returns:
        the color displayed when over a floating area

      • setFloatingColor

        public void setFloatingColor​(Color c)
        Sets the color displayed when over a floating area
        Parameters:
        c - the new color

      • canDock

        public boolean canDock​(Component c,
                       Point p)
        Returns true if the JToolBar can dock at the given position.
        Parameters:
        c - a component
        p - a position
        Returns:
        true if the JToolBar can dock at the given position

      • dragTo

        protected void dragTo​(Point position,
                      Point origin)
        The method is used to drag DragWindow during the JToolBar is being dragged.
        Parameters:
        position - the relative to the JTollBar position
        origin - the screen position of JToolBar before dragging

      • floatAt

        protected void floatAt​(Point position,
                       Point origin)
        The method is called at end of dragging to place the frame in either its original place or in its floating frame.
        Parameters:
        position - the relative to the JTollBar position
        origin - the screen position of JToolBar before dragging

      • createToolBarContListener

        protected ContainerListener createToolBarContListener​()
        Returns an instance of ContainerListener.
        Returns:
        an instance of ContainerListener

      • createToolBarFocusListener

        protected FocusListener createToolBarFocusListener​()
        Returns an instance of FocusListener.
        Returns:
        an instance of FocusListener

      • createPropertyListener

        protected PropertyChangeListener createPropertyListener​()
        Returns an instance of PropertyChangeListener.
        Returns:
        an instance of PropertyChangeListener

      • createDockingListener

        protected MouseInputListener createDockingListener​()
        Returns an instance of MouseInputListener.
        Returns:
        an instance of MouseInputListener

      • createFrameListener

        protected WindowListener createFrameListener​()
        Constructs a new instance of WindowListener.
        Returns:
        a new instance of WindowListener

      • paintDragWindow

        protected void paintDragWindow​(Graphics g)
        Paints the contents of the window used for dragging.
        Parameters:
        g - Graphics to paint to.
        Throws:
        NullPointerException - is g is null
        Since:
        1.5