Package Summary  Overview Summary

class:BasicSplitPaneUI [NONE]
Direct Known Subclasses:
MetalSplitPaneUI, SynthSplitPaneUI 
public class BasicSplitPaneUI
extends SplitPaneUI
A Basic L&F implementation of the SplitPaneUI.

field:NON_CONTINUOUS_DIVIDER [NONE]

  • NON_CONTINUOUS_DIVIDER

    protected static final  String NON_CONTINUOUS_DIVIDER
    The divider used for non-continuous layout is added to the split pane with this object.
    See Also:
    Constant Field Values

    • field:KEYBOARD_DIVIDER_MOVE_OFFSET [NONE]

    KEYBOARD_DIVIDER_MOVE_OFFSET

    protected static  int KEYBOARD_DIVIDER_MOVE_OFFSET
    How far (relative) the divider does move when it is moved around by the cursor keys on the keyboard.

    field:splitPane [NONE]

    splitPane

    protected JSplitPane splitPane
    JSplitPane instance this instance is providing the look and feel for.

    field:layoutManager [NONE]

    layoutManager

    protected BasicSplitPaneUI.BasicHorizontalLayoutManager layoutManager
    LayoutManager that is created and placed into the split pane.

    field:divider [NONE]

    divider

    protected BasicSplitPaneDivider divider
    Instance of the divider for this JSplitPane.

    field:propertyChangeListener [NONE]

    propertyChangeListener

    protected PropertyChangeListener propertyChangeListener
    Instance of the PropertyChangeListener for this JSplitPane.

    field:focusListener [NONE]

    focusListener

    protected FocusListener focusListener
    Instance of the FocusListener for this JSplitPane.

    field:dividerSize [NONE]

    dividerSize

    protected int dividerSize
    The size of the divider while the dragging session is valid.

    field:nonContinuousLayoutDivider [NONE]

    nonContinuousLayoutDivider

    protected Component nonContinuousLayoutDivider
    Instance for the shadow of the divider when non continuous layout is being used.

    field:draggingHW [NONE]

    draggingHW

    protected boolean draggingHW
    Set to true in startDragging if any of the children (not including the nonContinuousLayoutDivider) are heavy weights.

    field:beginDragDividerLocation [NONE]

    beginDragDividerLocation

    protected int beginDragDividerLocation
    Location of the divider when the dragging session began.

    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.

    field:homeKey [NONE]

    homeKey

    @Deprecatedprotected KeyStroke homeKey
    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:endKey [NONE]

    endKey

    @Deprecatedprotected KeyStroke endKey
    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:dividerResizeToggleKey [NONE]

    dividerResizeToggleKey

    @Deprecatedprotected KeyStroke dividerResizeToggleKey
    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:keyboardUpLeftListener [NONE]

    keyboardUpLeftListener

    @Deprecatedprotected ActionListener keyboardUpLeftListener
    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:keyboardDownRightListener [NONE]

    keyboardDownRightListener

    @Deprecatedprotected ActionListener keyboardDownRightListener
    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:keyboardHomeListener [NONE]

    keyboardHomeListener

    @Deprecatedprotected ActionListener keyboardHomeListener
    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:keyboardEndListener [NONE]

    keyboardEndListener

    @Deprecatedprotected ActionListener keyboardEndListener
    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:keyboardResizeToggleListener [NONE]

    keyboardResizeToggleListener

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

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

  • createUI

    public static  ComponentUI createUI?(JComponent x)
    Creates a new instance of BasicSplitPaneUI.
    Parameters:
    x - a component
    Returns:
    a new instance of BasicSplitPaneUI

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

    installUI

    public void installUI?(JComponent c)
    Installs the UI.
    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:installDefaults() [NONE]

    installDefaults

    protected void installDefaults()
    Installs the UI defaults.

    method:installListeners() [NONE]

    installListeners

    protected void installListeners()
    Installs the event listeners for the UI.

    method:installKeyboardActions() [NONE]

    installKeyboardActions

    protected void installKeyboardActions()
    Installs the keyboard actions for the UI.

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

    uninstallUI

    public void uninstallUI?(JComponent c)
    Uninstalls the UI.
    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:uninstallDefaults() [NONE]

    uninstallDefaults

    protected void uninstallDefaults()
    Uninstalls the UI defaults.

    method:uninstallListeners() [NONE]

    uninstallListeners

    protected void uninstallListeners()
    Uninstalls the event listeners for the UI.

    method:uninstallKeyboardActions() [NONE]

    uninstallKeyboardActions

    protected void uninstallKeyboardActions()
    Uninstalls the keyboard actions for the UI.

    method:createPropertyChangeListener() [NONE]

    createPropertyChangeListener

    protected PropertyChangeListener createPropertyChangeListener()
    Creates a PropertyChangeListener for the JSplitPane UI.
    Returns:
    an instance of PropertyChangeListener

    method:createFocusListener() [NONE]

    createFocusListener

    protected FocusListener createFocusListener()
    Creates a FocusListener for the JSplitPane UI.
    Returns:
    an instance of FocusListener

    method:createKeyboardUpLeftListener() [NONE]

    createKeyboardUpLeftListener

    @Deprecatedprotected ActionListener createKeyboardUpLeftListener()
    Deprecated.
    As of Java 2 platform v1.3.
    As of Java 2 platform v1.3 this method is no longer used. Subclassers previously using this method should instead create an Action wrapping the ActionListener, and register that Action by overriding installKeyboardActions and placing the Action in the SplitPane's ActionMap . Please refer to the key bindings specification for further details.

    Creates an ActionListener for the JSplitPane UI that listens for specific key presses.

    Returns:
    an instance of ActionListener

    method:createKeyboardDownRightListener() [NONE]

    createKeyboardDownRightListener

    @Deprecatedprotected ActionListener createKeyboardDownRightListener()
    Deprecated.
    As of Java 2 platform v1.3.
    As of Java 2 platform v1.3 this method is no longer used. Subclassers previously using this method should instead create an Action wrapping the ActionListener, and register that Action by overriding installKeyboardActions and placing the Action in the SplitPane's ActionMap . Please refer to the key bindings specification for further details.

    Creates an ActionListener for the JSplitPane UI that listens for specific key presses.

    Returns:
    an instance of ActionListener

    method:createKeyboardHomeListener() [NONE]

    createKeyboardHomeListener

    @Deprecatedprotected ActionListener createKeyboardHomeListener()
    Deprecated.
    As of Java 2 platform v1.3.
    As of Java 2 platform v1.3 this method is no longer used. Subclassers previously using this method should instead create an Action wrapping the ActionListener, and register that Action by overriding installKeyboardActions and placing the Action in the SplitPane's ActionMap . Please refer to the key bindings specification for further details.

    Creates an ActionListener for the JSplitPane UI that listens for specific key presses.

    Returns:
    an instance of ActionListener

    method:createKeyboardEndListener() [NONE]

    createKeyboardEndListener

    @Deprecatedprotected ActionListener createKeyboardEndListener()
    Deprecated.
    As of Java 2 platform v1.3.
    As of Java 2 platform v1.3 this method is no longer used. Subclassers previously using this method should instead create an Action wrapping the ActionListener, and register that Action by overriding installKeyboardActions and placing the Action in the SplitPane's ActionMap . Please refer to the key bindings specification for further details.

    Creates an ActionListener for the JSplitPane UI that listens for specific key presses.

    Returns:
    an instance of ActionListener

    method:createKeyboardResizeToggleListener() [NONE]

    createKeyboardResizeToggleListener

    @Deprecatedprotected ActionListener createKeyboardResizeToggleListener()
    Deprecated.
    As of Java 2 platform v1.3.
    As of Java 2 platform v1.3 this method is no longer used. Subclassers previously using this method should instead create an Action wrapping the ActionListener, and register that Action by overriding installKeyboardActions and placing the Action in the SplitPane's ActionMap . Please refer to the key bindings specification for further details.

    Creates an ActionListener for the JSplitPane UI that listens for specific key presses.

    Returns:
    an instance of ActionListener

    method:getOrientation() [NONE]

    getOrientation

    public int getOrientation()
    Returns the orientation for the JSplitPane.
    Returns:
    the orientation

    method:setOrientation(int) [NONE]

    setOrientation

    public void setOrientation?(int orientation)
    Set the orientation for the JSplitPane.
    Parameters:
    orientation - the orientation

    method:isContinuousLayout() [NONE]

    isContinuousLayout

    public boolean isContinuousLayout()
    Determines whether the JSplitPane is set to use a continuous layout.
    Returns:
    true if a continuous layout is set

    method:setContinuousLayout(boolean) [NONE]

    setContinuousLayout

    public void setContinuousLayout?(boolean b)
    Turn continuous layout on/off.
    Parameters:
    b - if true the continuous layout turns on

    method:getLastDragLocation() [NONE]

    getLastDragLocation

    public int getLastDragLocation()
    Returns the last drag location of the JSplitPane.
    Returns:
    the last drag location

    method:setLastDragLocation(int) [NONE]

    setLastDragLocation

    public void setLastDragLocation?(int l)
    Set the last drag location of the JSplitPane.
    Parameters:
    l - the drag location

    method:getDivider() [NONE]

    getDivider

    public BasicSplitPaneDivider getDivider()
    Returns the divider between the top Components.
    Returns:
    the divider between the top Components

    method:createDefaultNonContinuousLayoutDivider() [NONE]

    createDefaultNonContinuousLayoutDivider

    protected Component createDefaultNonContinuousLayoutDivider()
    Returns the default non continuous layout divider, which is an instance of Canvas that fills in the background with dark gray.
    Returns:
    the default non continuous layout divider

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

    setNonContinuousLayoutDivider

    protected void setNonContinuousLayoutDivider?(Component newDivider)
    Sets the divider to use when the JSplitPane is configured to not continuously layout. This divider will only be used during a dragging session. It is recommended that the passed in component be a heavy weight.
    Parameters:
    newDivider - the new divider

    method:setNonContinuousLayoutDivider(java.awt.Component,boolean) [NONE]

    setNonContinuousLayoutDivider

    protected void setNonContinuousLayoutDivider?(Component newDivider, boolean rememberSizes)
    Sets the divider to use.
    Parameters:
    newDivider - the new divider
    rememberSizes - if true the pane size is remembered

    method:getNonContinuousLayoutDivider() [NONE]

    getNonContinuousLayoutDivider

    public Component getNonContinuousLayoutDivider()
    Returns the divider to use when the JSplitPane is configured to not continuously layout. This divider will only be used during a dragging session.
    Returns:
    the divider

    method:getSplitPane() [NONE]

    getSplitPane

    public JSplitPane getSplitPane()
    Returns the JSplitPane this instance is currently contained in.
    Returns:
    the instance of JSplitPane

    method:createDefaultDivider() [NONE]

    createDefaultDivider

    public BasicSplitPaneDivider createDefaultDivider()
    Creates the default divider.
    Returns:
    the default divider

    method:resetToPreferredSizes(javax.swing.JSplitPane) [NONE]

    resetToPreferredSizes

    public void resetToPreferredSizes?(JSplitPane jc)
    Messaged to reset the preferred sizes.
    Specified by:
    resetToPreferredSizes in class SplitPaneUI
    Parameters:
    jc - a JSplitPane

    method:setDividerLocation(javax.swing.JSplitPane,int) [NONE]

    setDividerLocation

    public void setDividerLocation?(JSplitPane jc, int location)
    Sets the location of the divider to location.
    Specified by:
    setDividerLocation in class SplitPaneUI
    Parameters:
    jc - a JSplitPane
    location - an integer specifying the location of the divider

    method:getDividerLocation(javax.swing.JSplitPane) [NONE]

    getDividerLocation

    public int getDividerLocation?(JSplitPane jc)
    Returns the location of the divider, which may differ from what the splitpane thinks the location of the divider is.
    Specified by:
    getDividerLocation in class SplitPaneUI
    Parameters:
    jc - a JSplitPane
    Returns:
    an integer specifying the location of the divider

    method:getMinimumDividerLocation(javax.swing.JSplitPane) [NONE]

    getMinimumDividerLocation

    public int getMinimumDividerLocation?(JSplitPane jc)
    Gets the minimum location of the divider.
    Specified by:
    getMinimumDividerLocation in class SplitPaneUI
    Parameters:
    jc - a JSplitPane
    Returns:
    and integer specifying the minimum location of the divider

    method:getMaximumDividerLocation(javax.swing.JSplitPane) [NONE]

    getMaximumDividerLocation

    public int getMaximumDividerLocation?(JSplitPane jc)
    Gets the maximum location of the divider.
    Specified by:
    getMaximumDividerLocation in class SplitPaneUI
    Parameters:
    jc - a JSplitPane
    Returns:
    an integer specifying the maximum location of the divider

    method:finishedPaintingChildren(javax.swing.JSplitPane,java.awt.Graphics) [NONE]

    finishedPaintingChildren

    public void finishedPaintingChildren?(JSplitPane sp, Graphics g)
    Called when the specified split pane has finished painting its children.
    Specified by:
    finishedPaintingChildren in class SplitPaneUI
    Parameters:
    sp - a JSplitPane
    g - the Graphics context

    method:paint(java.awt.Graphics,javax.swing.JComponent) [NONE]

    paint

    public void paint?(Graphics g, JComponent jc)
    Paints the specified component appropriately for the look and feel. This method is invoked from the ComponentUI.update method when the specified component is being painted. Subclasses should override this method and use the specified Graphics object to render the content of the component.
    Overrides:
    paint in class ComponentUI
    Parameters:
    g - the Graphics context in which to paint
    jc - the component being painted; this argument is often ignored, but might be used if the UI object is stateless and shared by multiple components
    See Also:
    ComponentUI.update(java.awt.Graphics, javax.swing.JComponent)

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

    getPreferredSize

    public Dimension getPreferredSize?(JComponent jc)
    Returns the preferred size for the passed in component, This is passed off to the current layout manager.
    Overrides:
    getPreferredSize in class ComponentUI
    Parameters:
    jc - the component whose preferred size is being queried; this argument is often ignored, but might be used if the UI object is stateless and shared by multiple components
    Returns:
    a Dimension object containing given component's preferred size appropriate for the look and feel
    See Also:
    JComponent.getPreferredSize(), LayoutManager.preferredLayoutSize(java.awt.Container)

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

    getMinimumSize

    public Dimension getMinimumSize?(JComponent jc)
    Returns the minimum size for the passed in component, This is passed off to the current layout manager.
    Overrides:
    getMinimumSize in class ComponentUI
    Parameters:
    jc - the component whose minimum size is being queried; this argument is often ignored, but might be used if the UI object is stateless and shared by multiple components
    Returns:
    a Dimension object or null
    See Also:
    JComponent.getMinimumSize(), LayoutManager.minimumLayoutSize(java.awt.Container), ComponentUI.getPreferredSize(javax.swing.JComponent)

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

    getMaximumSize

    public Dimension getMaximumSize?(JComponent jc)
    Returns the maximum size for the passed in component, This is passed off to the current layout manager.
    Overrides:
    getMaximumSize in class ComponentUI
    Parameters:
    jc - the component whose maximum size is being queried; this argument is often ignored, but might be used if the UI object is stateless and shared by multiple components
    Returns:
    a Dimension object or null
    See Also:
    JComponent.getMaximumSize(), LayoutManager2.maximumLayoutSize(java.awt.Container)

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

    getInsets

    public Insets getInsets?(JComponent jc)
    Returns the insets. The insets are returned from the border insets of the current border.
    Parameters:
    jc - a component
    Returns:
    the insets

    method:resetLayoutManager() [NONE]

    resetLayoutManager

    protected void resetLayoutManager()
    Resets the layout manager based on orientation and messages it with invalidateLayout to pull in appropriate Components.

    method:startDragging() [NONE]

    startDragging

    protected void startDragging()
    Should be messaged before the dragging session starts, resets lastDragLocation and dividerSize.

    method:dragDividerTo(int) [NONE]

    dragDividerTo

    protected void dragDividerTo?(int location)
    Messaged during a dragging session to move the divider to the passed in location. If continuousLayout is true the location is reset and the splitPane validated.
    Parameters:
    location - the location of divider

    method:finishDraggingTo(int) [NONE]

    finishDraggingTo

    protected void finishDraggingTo?(int location)
    Messaged to finish the dragging session. If not continuous display the dividers location will be reset.
    Parameters:
    location - the location of divider

    method:getDividerBorderSize() [NONE]

    getDividerBorderSize

    @Deprecatedprotected int getDividerBorderSize()
    Deprecated.
    As of Java 2 platform v1.3, instead set the border on the divider.
    As of Java 2 platform v1.3 this method is no longer used. Instead you should set the border on the divider.

    Returns the width of one side of the divider border.

    Returns:
    the width of one side of the divider border

    © 2020 Oracle Corporation and/or its affiliates