Class BasicSplitPaneDivider

Field Detail

• ONE_TOUCH_SIZE

  protected static final int ONE_TOUCH_SIZE

  Width or height of the divider based on orientation BasicSplitPaneUI adds two to this.

  See Also:

  Constant Field Values

• ONE_TOUCH_OFFSET

  protected static final int ONE_TOUCH_OFFSET

  See Also:

  Constant Field Values

• dragger

  protected BasicSplitPaneDivider.DragController dragger

  Handles mouse dragging message to do the actual dragging.

• splitPaneUI

  protected BasicSplitPaneUI splitPaneUI

  UI this instance was created from.

• dividerSize

  protected int dividerSize

  Size of the divider.

• hiddenDivider

  protected Component hiddenDivider

  Divider that is used for noncontinuous layout mode.

• splitPane

  protected JSplitPane splitPane

  JSplitPane the receiver is contained in.

• mouseHandler

  protected BasicSplitPaneDivider.MouseHandler mouseHandler

  Handles mouse events from both this class, and the split pane. Mouse events are handled for the splitpane since you want to be able to drag when clicking on the border of the divider, which is not drawn by the divider.

• orientation

  protected int orientation

  Orientation of the JSplitPane.

• leftButton

  protected JButton leftButton

  Button for quickly toggling the left component.

• rightButton

  protected JButton rightButton

  Button for quickly toggling the right component.

Constructor Detail

• BasicSplitPaneDivider

  public BasicSplitPaneDivider(BasicSplitPaneUI ui)

  Creates an instance of BasicSplitPaneDivider. Registers this instance for mouse events and mouse dragged events.

Method Detail

• setBasicSplitPaneUI

  public void setBasicSplitPaneUI(BasicSplitPaneUI newUI)

  Sets the SplitPaneUI that is using the receiver.

• getBasicSplitPaneUI

  public BasicSplitPaneUI getBasicSplitPaneUI()

  Returns the SplitPaneUI the receiver is currently in.

• setDividerSize

  public void setDividerSize(int newSize)

  Sets the size of the divider to newSize. That is the width if the splitpane is HORIZONTAL_SPLIT, or the height of VERTICAL_SPLIT.

• getDividerSize

  public int getDividerSize()

  Returns the size of the divider, that is the width if the splitpane is HORIZONTAL_SPLIT, or the height of VERTICAL_SPLIT.

• setBorder

  public void setBorder(Border border)

  Sets the border of this component.

  Since:

  1.3

• getBorder

  public Border getBorder()

  Returns the border of this component or null if no border is currently set.

  Returns:

  the border object for this component

  Since:

  1.3

  See Also:

  setBorder(javax.swing.border.Border)

• getInsets

  public Insets getInsets()

  If a border has been set on this component, returns the border's insets, else calls super.getInsets.

  Overrides:

  getInsets in class Container

  Returns:

  the value of the insets property.

  See Also:

  setBorder(javax.swing.border.Border)

• setMouseOver

  protected void setMouseOver(boolean mouseOver)

  Sets whether or not the mouse is currently over the divider.

  Parameters:

  mouseOver - whether or not the mouse is currently over the divider

  Since:

  1.5

• isMouseOver

  public boolean isMouseOver()

  Returns whether or not the mouse is currently over the divider

  Returns:

  whether or not the mouse is currently over the divider

  Since:

  1.5

• getPreferredSize

  public Dimension getPreferredSize()

  Returns dividerSize x dividerSize

  Overrides:

  getPreferredSize in class Container

  Returns:

  an instance of Dimension that represents the preferred size of this container.

  See Also:

  Container.getMinimumSize(), Container.getMaximumSize(), Container.getLayout(), LayoutManager.preferredLayoutSize(Container), Component.getPreferredSize()

• getMinimumSize

  public Dimension getMinimumSize()

  Returns dividerSize x dividerSize

  Overrides:

  getMinimumSize in class Container

  Returns:

  an instance of Dimension that represents the minimum size of this container.

  See Also:

  Container.getPreferredSize(), Container.getMaximumSize(), Container.getLayout(), LayoutManager.minimumLayoutSize(Container), Component.getMinimumSize()

• propertyChange

  public void propertyChange(PropertyChangeEvent e)

  Property change event, presumably from the JSplitPane, will message updateOrientation if necessary.

  Specified by:

  propertyChange in interface PropertyChangeListener

  Parameters:

  e - A PropertyChangeEvent object describing the event source and the property that has changed.

• paint

  public void paint(Graphics g)

  Paints the divider.

  Overrides:

  paint in class Container

  Parameters:

  g - the specified Graphics window

  See Also:

  Component.update(Graphics)

• oneTouchExpandableChanged

  protected void oneTouchExpandableChanged()

  Messaged when the oneTouchExpandable value of the JSplitPane the receiver is contained in changes. Will create the leftButton and rightButton if they are null. invalidates the receiver as well.

• createLeftOneTouchButton

  protected JButton createLeftOneTouchButton()

  Creates and return an instance of JButton that can be used to collapse the left component in the split pane.

• createRightOneTouchButton

  protected JButton createRightOneTouchButton()

  Creates and return an instance of JButton that can be used to collapse the right component in the split pane.

• prepareForDragging

  protected void prepareForDragging()

  Message to prepare for dragging. This messages the BasicSplitPaneUI with startDragging.

• dragDividerTo

  protected void dragDividerTo(int location)

  Messages the BasicSplitPaneUI with dragDividerTo that this instance is contained in.

• finishDraggingTo

  protected void finishDraggingTo(int location)

  Messages the BasicSplitPaneUI with finishDraggingTo that this instance is contained in.