Package Summary  Overview Summary

class:BasicToolBarUI [NONE]
All Implemented Interfaces:
SwingConstants
Direct Known Subclasses:
MetalToolBarUI, SynthToolBarUI 
public class BasicToolBarUI
extends ToolBarUI
implements SwingConstants
A Basic L&F implementation of ToolBarUI. This implementation is a "combined" view/controller.

field:toolBar [NONE]

  • toolBar

    protected JToolBar toolBar
    The instance of JToolBar.

    • field:dragWindow [NONE]

    dragWindow

    protected BasicToolBarUI.DragWindow dragWindow
    The instance of DragWindow.

    field:focusedCompIndex [NONE]

    focusedCompIndex

    protected int focusedCompIndex
    The index of the focused component.

    field:dockingColor [NONE]

    dockingColor

    protected Color dockingColor
    The background color of the docking border.

    field:floatingColor [NONE]

    floatingColor

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

    field:dockingBorderColor [NONE]

    dockingBorderColor

    protected Color dockingBorderColor
    The color of the docking border.

    field:floatingBorderColor [NONE]

    floatingBorderColor

    protected Color floatingBorderColor
    The color of the not docking border.

    field:dockingListener [NONE]

    dockingListener

    protected MouseInputListener dockingListener
    The instance of a MouseInputListener.

    field:propertyListener [NONE]

    propertyListener

    protected PropertyChangeListener propertyListener
    The instance of a PropertyChangeListener.

    field:toolBarContListener [NONE]

    toolBarContListener

    protected ContainerListener toolBarContListener
    The instance of a ContainerListener.

    field:toolBarFocusListener [NONE]

    toolBarFocusListener

    protected FocusListener toolBarFocusListener
    The instance of a FocusListener.

    field:constraintBeforeFloating [NONE]

    constraintBeforeFloating

    protected String constraintBeforeFloating
    The layout before floating.

    field:upKey [NONE]

    upKey

    @Deprecatedprotected 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.

    field:downKey [NONE]

    downKey

    @Deprecatedprotected 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.

    field:leftKey [NONE]

    leftKey

    @Deprecatedprotected 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.

    field:rightKey [NONE]

    rightKey

    @Deprecatedprotected 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:BasicToolBarUI() [NONE]

    method:createUI(javax.swing.JComponent) [NONE]

  • createUI

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

    • method:installUI(javax.swing.JComponent) [NONE]

    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()

    method:uninstallUI(javax.swing.JComponent) [NONE]

    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()

    method:installDefaults() [NONE]

    installDefaults

    protected void installDefaults()
    Installs default properties.

    method:uninstallDefaults() [NONE]

    uninstallDefaults

    protected void uninstallDefaults()
    Uninstalls default properties.

    method:installComponents() [NONE]

    installComponents

    protected void installComponents()
    Registers components.

    method:uninstallComponents() [NONE]

    uninstallComponents

    protected void uninstallComponents()
    Unregisters components.

    method:installListeners() [NONE]

    installListeners

    protected void installListeners()
    Registers listeners.

    method:uninstallListeners() [NONE]

    uninstallListeners

    protected void uninstallListeners()
    Unregisters listeners.

    method:installKeyboardActions() [NONE]

    installKeyboardActions

    protected void installKeyboardActions()
    Registers keyboard actions.

    method:uninstallKeyboardActions() [NONE]

    uninstallKeyboardActions

    protected void uninstallKeyboardActions()
    Unregisters keyboard actions.

    method:navigateFocusedComp(int) [NONE]

    navigateFocusedComp

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

    method:createRolloverBorder() [NONE]

    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

    method:createNonRolloverBorder() [NONE]

    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

    method:createFloatingFrame(javax.swing.JToolBar) [NONE]

    createFloatingFrame

    protected JFrame createFloatingFrame?(JToolBar toolbar)
    No longer used, use BasicToolBarUI.createFloatingWindow(JToolBar)
    Parameters:
    toolbar - an instance of JToolBar
    Returns:
    an instance of JFrame
    See Also:
    createFloatingWindow(javax.swing.JToolBar)

    method:createFloatingWindow(javax.swing.JToolBar) [NONE]

    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

    method:createDragWindow(javax.swing.JToolBar) [NONE]

    createDragWindow

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

    method:isRolloverBorders() [NONE]

    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)

    method:setRolloverBorders(boolean) [NONE]

    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()

    method:installRolloverBorders(javax.swing.JComponent) [NONE]

    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)

    method:installNonRolloverBorders(javax.swing.JComponent) [NONE]

    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)

    method:installNormalBorders(javax.swing.JComponent) [NONE]

    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)

    method:setBorderToRollover(java.awt.Component) [NONE]

    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()

    method:getRolloverBorder(javax.swing.AbstractButton) [NONE]

    getRolloverBorder

    protected Border getRolloverBorder?(AbstractButton b)
    Returns a rollover border for the button.
    Parameters:
    b - the button to calculate the rollover border for
    Returns:
    the rollover border
    Since:
    1.6
    See Also:
    setBorderToRollover(java.awt.Component)

    method:setBorderToNonRollover(java.awt.Component) [NONE]

    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()

    method:getNonRolloverBorder(javax.swing.AbstractButton) [NONE]

    getNonRolloverBorder

    protected Border getNonRolloverBorder?(AbstractButton b)
    Returns a non-rollover border for the button.
    Parameters:
    b - the button to calculate the non-rollover border for
    Returns:
    the non-rollover border
    Since:
    1.6
    See Also:
    setBorderToNonRollover(java.awt.Component)

    method:setBorderToNormal(java.awt.Component) [NONE]

    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()

    method:setFloatingLocation(int,int) [NONE]

    setFloatingLocation

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

    method:isFloating() [NONE]

    isFloating

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

    method:setFloating(boolean,java.awt.Point) [NONE]

    setFloating

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

    method:setOrientation(int) [NONE]

    setOrientation

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

    method:getDockingColor() [NONE]

    getDockingColor

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

    method:setDockingColor(java.awt.Color) [NONE]

    setDockingColor

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

    method:getFloatingColor() [NONE]

    getFloatingColor

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

    method:setFloatingColor(java.awt.Color) [NONE]

    setFloatingColor

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

    method:canDock(java.awt.Component,java.awt.Point) [NONE]

    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

    method:dragTo(java.awt.Point,java.awt.Point) [NONE]

    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

    method:floatAt(java.awt.Point,java.awt.Point) [NONE]

    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

    method:createToolBarContListener() [NONE]

    createToolBarContListener

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

    method:createToolBarFocusListener() [NONE]

    createToolBarFocusListener

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

    method:createPropertyListener() [NONE]

    createPropertyListener

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

    method:createDockingListener() [NONE]

    createDockingListener

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

    method:createFrameListener() [NONE]

    createFrameListener

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

    method:paintDragWindow(java.awt.Graphics) [NONE]

    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

    © 2020 Oracle Corporation and/or its affiliates