* Implementation status: We do not have a real implementation yet. Currently, * it is mostly a stub to allow compiling other parts of the * javax.swing.plaf.basic package, although some parts are already * functional. *
* * @author Sascha Brawer (brawer_AT_dandelis.ch) */ public class BasicSplitPaneDivider extends Container implements PropertyChangeListener { /** * The buttons used as one touch buttons. */ private class BasicOneTouchButton extends JButton { /** * Denotes a left button. */ static final int LEFT = 0; /** * Denotes a right button. */ static final int RIGHT = 1; /** * The x points for the arrow. */ private int[] xpoints; /** * The y points for the arrow. */ private int[] ypoints; /** * Either LEFT or RIGHT. */ private int direction; /** * Creates a new instance. * * @param dir either LEFT or RIGHT */ BasicOneTouchButton(int dir) { direction = dir; xpoints = new int[3]; ypoints = new int[3]; } /** * Never allow borders. */ public void setBorder(Border b) { } /** * Never allow focus traversal. */ public boolean isFocusTraversable() { return false; } /** * Paints the one touch button. */ public void paint(Graphics g) { if (splitPane != null) { // Fill background. g.setColor(splitPane.getBackground()); g.fillRect(0, 0, getWidth(), getHeight()); // Draw arrow. int size; if (direction == LEFT) { if (orientation == JSplitPane.VERTICAL_SPLIT) { size = Math.min(getHeight(), ONE_TOUCH_SIZE); xpoints[0] = 0; xpoints[1] = size / 2; xpoints[2] = size; ypoints[0] = size; ypoints[1] = 0; ypoints[2] = size; } else { size = Math.min(getWidth(), ONE_TOUCH_SIZE); xpoints[0] = size; xpoints[1] = 0; xpoints[2] = size; ypoints[0] = 0; ypoints[1] = size / 2; ypoints[2] = size; } } else { if (orientation == JSplitPane.VERTICAL_SPLIT) { size = Math.min(getHeight(), ONE_TOUCH_SIZE); xpoints[0] = 0; xpoints[1] = size / 2; xpoints[2] = size; ypoints[0] = 0; ypoints[1] = size; ypoints[2] = 0; } else { size = Math.min(getWidth(), ONE_TOUCH_SIZE); xpoints[0] = 0; xpoints[1] = size; xpoints[2] = 0; ypoints[0] = 0; ypoints[1] = size / 2; ypoints[2] = size; } } g.setColor(Color.BLACK); g.fillPolygon(xpoints, ypoints, 3); } } } /** * Listens for actions on the one touch buttons. */ private class OneTouchAction implements ActionListener { public void actionPerformed(ActionEvent ev) { Insets insets = splitPane.getInsets(); int lastLoc = splitPane.getLastDividerLocation(); int currentLoc = splitPaneUI.getDividerLocation(splitPane); int newLoc; if (ev.getSource() == leftButton) { if (orientation == JSplitPane.VERTICAL_SPLIT) { if (currentLoc >= splitPane.getHeight() - insets.bottom - getHeight()) { newLoc = Math.min(splitPane.getMaximumDividerLocation(), lastLoc); } else { newLoc = insets.top; } } else { if (currentLoc >= splitPane.getWidth() - insets.right - getWidth()) { newLoc = Math.min(splitPane.getMaximumDividerLocation(), lastLoc); } else { newLoc = insets.left; } } } else { if (orientation == JSplitPane.VERTICAL_SPLIT) { if (currentLoc == insets.top) { newLoc = Math.min(splitPane.getMaximumDividerLocation(), lastLoc); } else { newLoc = splitPane.getHeight() - insets.top - getHeight(); } } else { if (currentLoc == insets.left) { newLoc = Math.min(splitPane.getMaximumDividerLocation(), lastLoc); } else { newLoc = splitPane.getWidth() - insets.left - getWidth(); } } } if (currentLoc != newLoc) { splitPane.setDividerLocation(newLoc); splitPane.setLastDividerLocation(currentLoc); } } } /** * Determined using theserialver tool of Apple/Sun JDK 1.3.1
* on MacOS X 10.1.5.
*/
static final long serialVersionUID = 1463404307042803342L;
/**
* The width and height of the little buttons for showing and hiding parts
* of a JSplitPane in a single mouse click.
*/
protected static final int ONE_TOUCH_SIZE = 6;
/** The distance the one touch buttons will sit from the divider's edges. */
protected static final int ONE_TOUCH_OFFSET = 2;
/**
* An object that performs the tasks associated with an ongoing drag
* operation, or null if the user is currently not dragging
* the divider.
*/
protected DragController dragger;
/**
* The delegate object that is responsible for the UI of the
* JSplitPane that contains this divider.
*/
protected BasicSplitPaneUI splitPaneUI;
/** The thickness of the divider in pixels. */
protected int dividerSize;
/** A divider that is used for layout purposes. */
protected Component hiddenDivider;
/** The JSplitPane containing this divider. */
protected JSplitPane splitPane;
/**
* The listener for handling mouse events from both the divider and the
* containing JSplitPane.
*
*
* The reason for also handling MouseEvents from the containing
* JSplitPane is that users should be able to start a drag
* gesture from inside the JSplitPane, but slightly outisde the divider.
*
JSplitPane, which
* is either {@link javax.swing.JSplitPane#HORIZONTAL_SPLIT} or {@link
* javax.swing.JSplitPane#VERTICAL_SPLIT}.
*/
protected int orientation;
/**
* The button for showing and hiding the left (or top) component of the
* JSplitPane.
*/
protected JButton leftButton;
/**
* The button for showing and hiding the right (or bottom) component of the
* JSplitPane.
*/
protected JButton rightButton;
/**
* The border of this divider. Typically, this will be an instance of {@link
* javax.swing.plaf.basic.BasicBorders.SplitPaneDividerBorder}.
*
* @see #getBorder()
* @see #setBorder(javax.swing.border.Border)
*/
private Border border;
// This is not a pixel count.
// This int should be able to take 3 values.
// left (top), middle, right(bottom)
// 0 1 2
/**
* Keeps track of where the divider should be placed when using one touch
* expand buttons.
* This is package-private to avoid an accessor method.
*/
transient int currentDividerLocation = 1;
/**
* Indicates if the ont touch buttons are laid out centered or at the
* top/left.
*
* Package private to avoid accessor method.
*/
boolean centerOneTouchButtons;
/**
* Constructs a new divider.
*
* @param ui the UI delegate of the enclosing JSplitPane.
*/
public BasicSplitPaneDivider(BasicSplitPaneUI ui)
{
setLayout(new DividerLayout());
setBasicSplitPaneUI(ui);
setDividerSize(splitPane.getDividerSize());
centerOneTouchButtons =
UIManager.getBoolean("SplitPane.centerOneTouchButtons");
}
/**
* Sets the delegate object that is responsible for the UI of the {@link
* javax.swing.JSplitPane} containing this divider.
*
* @param newUI the UI delegate, or null to release the
* connection to the current delegate.
*/
public void setBasicSplitPaneUI(BasicSplitPaneUI newUI)
{
/* Remove the connection to the existing JSplitPane. */
if (splitPane != null)
{
splitPane.removePropertyChangeListener(this);
removeMouseListener(mouseHandler);
removeMouseMotionListener(mouseHandler);
splitPane = null;
hiddenDivider = null;
}
/* Establish the connection to the new JSplitPane. */
splitPaneUI = newUI;
if (splitPaneUI != null)
splitPane = newUI.getSplitPane();
if (splitPane != null)
{
splitPane.addPropertyChangeListener(this);
addMouseListener(mouseHandler);
addMouseMotionListener(mouseHandler);
hiddenDivider = splitPaneUI.getNonContinuousLayoutDivider();
orientation = splitPane.getOrientation();
if (splitPane.isOneTouchExpandable())
oneTouchExpandableChanged();
}
}
/**
* Returns the delegate object that is responsible for the UI of the {@link
* javax.swing.JSplitPane} containing this divider.
*
* @return The UI for the JSplitPane.
*/
public BasicSplitPaneUI getBasicSplitPaneUI()
{
return splitPaneUI;
}
/**
* Sets the thickness of the divider.
*
* @param newSize the new width or height in pixels.
*/
public void setDividerSize(int newSize)
{
this.dividerSize = newSize;
}
/**
* Retrieves the thickness of the divider.
*
* @return The thickness of the divider.
*/
public int getDividerSize()
{
return dividerSize;
}
/**
* Sets the border of this divider.
*
* @param border the new border. Typically, this will be an instance of
* {@link
* javax.swing.plaf.basic.BasicBorders.SplitPaneBorder}.
*
* @since 1.3
*/
public void setBorder(Border border)
{
if (border != this.border)
{
Border oldValue = this.border;
this.border = border;
firePropertyChange("border", oldValue, border);
}
}
/**
* Retrieves the border of this divider.
*
* @return the current border, or null if no border has been
* set.
*
* @since 1.3
*/
public Border getBorder()
{
return border;
}
/**
* Retrieves the insets of the divider. If a border has been installed on
* the divider, the result of calling its getBorderInsets
* method is returned. Otherwise, the inherited implementation will be
* invoked.
*
* @see javax.swing.border.Border#getBorderInsets(java.awt.Component)
*/
public Insets getInsets()
{
if (border != null)
return border.getBorderInsets(this);
else
return super.getInsets();
}
/**
* Returns the preferred size of this divider, which is
* dividerSize by dividerSize pixels.
*
* @return The preferred size of the divider.
*/
public Dimension getPreferredSize()
{
Dimension d;
if (orientation == JSplitPane.HORIZONTAL_SPLIT)
d = new Dimension(getDividerSize(), 1);
else
d = new Dimension(1, getDividerSize());
return d;
}
/**
* Returns the minimal size of this divider, which is
* dividerSize by dividerSize pixels.
*
* @return The minimal size of the divider.
*/
public Dimension getMinimumSize()
{
return getPreferredSize();
}
/**
* Processes events from the JSplitPane that contains this
* divider.
*
* @param e The PropertyChangeEvent.
*/
public void propertyChange(PropertyChangeEvent e)
{
if (e.getPropertyName().equals(JSplitPane.ONE_TOUCH_EXPANDABLE_PROPERTY))
oneTouchExpandableChanged();
else if (e.getPropertyName().equals(JSplitPane.ORIENTATION_PROPERTY))
{
orientation = splitPane.getOrientation();
invalidate();
if (splitPane != null)
splitPane.revalidate();
}
else if (e.getPropertyName().equals(JSplitPane.DIVIDER_SIZE_PROPERTY))
dividerSize = splitPane.getDividerSize();
}
/**
* Paints the divider by painting its border.
*
* @param g The Graphics Object to paint with.
*/
public void paint(Graphics g)
{
Dimension dividerSize;
super.paint(g);
if (border != null)
{
dividerSize = getSize();
border.paintBorder(this, g, 0, 0, dividerSize.width, dividerSize.height);
}
}
/**
* Reacts to changes of the oneToughExpandable property of the
* containing JSplitPane.
*/
protected void oneTouchExpandableChanged()
{
if (splitPane.isOneTouchExpandable())
{
leftButton = createLeftOneTouchButton();
if (leftButton != null)
leftButton.addActionListener(new OneTouchAction());
rightButton = createRightOneTouchButton();
if (rightButton != null)
rightButton.addActionListener(new OneTouchAction());
// Only add them when both are non-null.
if (leftButton != null && rightButton != null)
{
add(leftButton);
add(rightButton);
}
}
invalidate();
if (splitPane != null)
splitPane.revalidate();
}
/**
* Creates a button for showing and hiding the left (or top) part of a
* JSplitPane.
*
* @return The left one touch button.
*/
protected JButton createLeftOneTouchButton()
{
JButton button = new BasicOneTouchButton(BasicOneTouchButton.LEFT);
button.setMinimumSize(new Dimension(ONE_TOUCH_SIZE, ONE_TOUCH_SIZE));
button.setRequestFocusEnabled(false);
return button;
}
/**
* Creates a button for showing and hiding the right (or bottom) part of a
* JSplitPane.
*
* @return The right one touch button.
*/
protected JButton createRightOneTouchButton()
{
JButton button = new BasicOneTouchButton(BasicOneTouchButton.RIGHT);
button.setMinimumSize(new Dimension(ONE_TOUCH_SIZE, ONE_TOUCH_SIZE));
button.setRequestFocusEnabled(false);
return button;
}
/**
* Prepares the divider for dragging by calling the
* startDragging method of the UI delegate of the enclosing
* JSplitPane.
*
* @see BasicSplitPaneUI#startDragging()
*/
protected void prepareForDragging()
{
if (splitPaneUI != null)
splitPaneUI.startDragging();
}
/**
* Drags the divider to a given location by calling the
* dragDividerTo method of the UI delegate of the enclosing
* JSplitPane.
*
* @param location the new location of the divider.
*
* @see BasicSplitPaneUI#dragDividerTo(int location)
*/
protected void dragDividerTo(int location)
{
if (splitPaneUI != null)
splitPaneUI.dragDividerTo(location);
}
/**
* Finishes a dragging gesture by calling the finishDraggingTo
* method of the UI delegate of the enclosing JSplitPane.
*
* @param location the new, final location of the divider.
*
* @see BasicSplitPaneUI#finishDraggingTo(int location)
*/
protected void finishDraggingTo(int location)
{
if (splitPaneUI != null)
splitPaneUI.finishDraggingTo(location);
}
/**
* This helper method moves the divider to one of the three locations when
* using one touch expand buttons. Location 0 is the left (or top) most
* location. Location 1 is the middle. Location 2 is the right (or bottom)
* most location.
* This is package-private to avoid an accessor method.
*
* @param locationIndex The location to move to.
*/
void moveDividerTo(int locationIndex)
{
Insets insets = splitPane.getInsets();
switch (locationIndex)
{
case 1:
splitPane.setDividerLocation(splitPane.getLastDividerLocation());
break;
case 0:
int top = (orientation == JSplitPane.HORIZONTAL_SPLIT) ? insets.left
: insets.top;
splitPane.setDividerLocation(top);
break;
case 2:
int bottom;
if (orientation == JSplitPane.HORIZONTAL_SPLIT)
bottom = splitPane.getBounds().width - insets.right - dividerSize;
else
bottom = splitPane.getBounds().height - insets.bottom - dividerSize;
splitPane.setDividerLocation(bottom);
break;
}
}
/**
* The listener for handling mouse events from both the divider and the
* containing JSplitPane.
*
*
* The reason for also handling MouseEvents from the containing
* JSplitPane is that users should be able to start a drag
* gesture from inside the JSplitPane, but slightly outisde the divider.
*