Modifier and Type	Class and Description
protected class	BasicSplitPaneDivider.DividerLayout Used to layout a `BasicSplitPaneDivider`.
protected class	BasicSplitPaneDivider.DragController Handles the events during a dragging session for a HORIZONTAL_SPLIT oriented split pane.
protected class	BasicSplitPaneDivider.MouseHandler MouseHandler is responsible for converting mouse events (released, dragged...) into the appropriate DragController methods.
private class	BasicSplitPaneDivider.OneTouchActionHandler Listeners installed on the one touch expandable buttons.
protected class	BasicSplitPaneDivider.VerticalDragController Handles the events during a dragging session for a VERTICAL_SPLIT oriented split pane.

Modifier and Type	Field and Description
private Border	border Border.
private boolean	centerOneTouchButtons If true the one touch buttons are centered on the divider.
protected int	dividerSize Size of the divider.
protected BasicSplitPaneDivider.DragController	dragger Handles mouse dragging message to do the actual dragging.
protected Component	hiddenDivider Divider that is used for noncontinuous layout mode.
protected JButton	leftButton Button for quickly toggling the left component.
protected BasicSplitPaneDivider.MouseHandler	mouseHandler Handles mouse events from both this class, and the split pane.
private boolean	mouseOver Is the mouse over the divider?
protected static final int	ONE_TOUCH_OFFSET The offset of the divider.
protected static final int	ONE_TOUCH_SIZE Width or height of the divider based on orientation `BasicSplitPaneUI` adds two to this.
private int	oneTouchOffset
private int	oneTouchSize
protected int	orientation Orientation of the JSplitPane.
protected JButton	rightButton Button for quickly toggling the right component.
protected JSplitPane	splitPane JSplitPane the receiver is contained in.
protected BasicSplitPaneUI	splitPaneUI UI this instance was created from.

Access	Constructor and Description
public	BasicSplitPaneDivider(BasicSplitPaneUI an instance of `BasicSplitPaneUI` ui) Creates an instance of `BasicSplitPaneDivider`.

Method Summary

Modifier and Type	Method and Description
protected JButton	Returns: an instance of `JButton` createLeftOneTouchButton() Creates and return an instance of `JButton` that can be used to collapse the left component in the split pane.
protected JButton	Returns: an instance of `JButton` createRightOneTouchButton() Creates and return an instance of `JButton` that can be used to collapse the right component in the split pane.
protected void	dragDividerTo(int a location location) Messages the BasicSplitPaneUI with dragDividerTo that this instance is contained in.
protected void	finishDraggingTo(int a location location) Messages the BasicSplitPaneUI with finishDraggingTo that this instance is contained in.
public BasicSplitPaneUI	Returns: the `SplitPaneUI` the receiver is currently in getBasicSplitPaneUI() Returns the `SplitPaneUI` the receiver is currently in.
public Border	Returns: the border object for this component getBorder() Returns the border of this component or null if no border is currently set.
public int	Returns: the size of the divider getDividerSize() Returns the size of the divider, that is the width if the splitpane is HORIZONTAL_SPLIT, or the height of VERTICAL_SPLIT.
public Insets	Returns: the value of the insets property. getInsets() Overrides java.awt.Container.getInsets. If a border has been set on this component, returns the border's insets, else calls super.getInsets.
public Dimension	Returns: a `Dimension` object containing the minimum size of `BasicSplitPaneDivider` getMinimumSize() Overrides java.awt.Container.getMinimumSize. Returns the minimum size of the divider.
public Dimension	Returns: a `Dimension` object containing the preferred size of `BasicSplitPaneDivider` getPreferredSize() Overrides java.awt.Container.getPreferredSize. Returns the preferred size of the divider.
public boolean	Returns: whether or not the mouse is currently over the divider isMouseOver() Returns whether or not the mouse is currently over the divider
protected void	oneTouchExpandableChanged() Messaged when the oneTouchExpandable value of the JSplitPane the divider is contained in changes.
public void	paint(Graphics g) Overrides java.awt.Container.paint. Paints the divider.
protected void	prepareForDragging() Message to prepare for dragging.
public void	propertyChange(PropertyChangeEvent e) Implements java.beans.PropertyChangeListener.propertyChange. Property change event, presumably from the JSplitPane, will message updateOrientation if necessary.
private void	revalidateSplitPane()
public void	setBasicSplitPaneUI(BasicSplitPaneUI the new `SplitPaneUI` newUI) Sets the `SplitPaneUI` that is using the receiver.
public void	setBorder(Border a new border border) Sets the border of this component.
public void	setDividerSize(int a new size newSize) Sets the size of the divider to `newSize`.
public void	setEnabled(boolean enabled) Overrides java.awt.Component.setEnabled. Enables or disables this component, depending on the value of the parameter `b`.
protected void	setMouseOver(boolean whether or not the mouse is currently over the divider mouseOver) Sets whether or not the mouse is currently over the divider.

Inherited from java.awt.Container:: add add add add add addContainerListener addImpl addNotify addPropertyChangeListener addPropertyChangeListener applyComponentOrientation areFocusTraversalKeysSet countComponents deliverEvent doLayout findComponentAt findComponentAt getAlignmentX getAlignmentY getComponent getComponentAt getComponentAt getComponentCount getComponents getComponentZOrder getContainerListeners getFocusTraversalKeys getFocusTraversalPolicy getLayout getListeners getMaximumSize getMousePosition insets invalidate isAncestorOf isFocusCycleRoot isFocusCycleRoot isFocusTraversalPolicyProvider isFocusTraversalPolicySet isValidateRoot layout list list locate minimumSize paintComponents paramString preferredSize print printComponents processContainerEvent processEvent remove remove removeAll removeContainerListener removeNotify setComponentZOrder setFocusCycleRoot setFocusTraversalKeys setFocusTraversalPolicy setFocusTraversalPolicyProvider setFont setLayout transferFocusDownCycle update validate validateTree

Field Detail

border	back to summary
private Border border Border.

centerOneTouchButtons	back to summary
private boolean centerOneTouchButtons If true the one touch buttons are centered on the divider.

dividerSize	back to summary
protected int dividerSize Size of the divider.

dragger	back to summary
protected BasicSplitPaneDivider.DragController dragger Handles mouse dragging message to do the actual dragging.

hiddenDivider	back to summary
protected Component hiddenDivider Divider that is used for noncontinuous layout mode.

leftButton	back to summary
protected JButton leftButton Button for quickly toggling the left component.

mouseHandler	back to summary
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.

mouseOver	back to summary
private boolean mouseOver Is the mouse over the divider?

ONE_TOUCH_OFFSET	back to summary
protected static final int ONE_TOUCH_OFFSET The offset of the divider.

ONE_TOUCH_SIZE	back to summary
protected static final int ONE_TOUCH_SIZE Width or height of the divider based on orientation `BasicSplitPaneUI` adds two to this.

oneTouchOffset	back to summary
private int oneTouchOffset

oneTouchSize	back to summary
private int oneTouchSize

orientation	back to summary
protected int orientation Orientation of the JSplitPane.

rightButton	back to summary
protected JButton rightButton Button for quickly toggling the right component.

splitPane	back to summary
protected JSplitPane splitPane JSplitPane the receiver is contained in.

splitPaneUI	back to summary
protected BasicSplitPaneUI splitPaneUI UI this instance was created from.

Constructor Detail

BasicSplitPaneDivider back to summary

BasicSplitPaneDivider	back to summary
public BasicSplitPaneDivider(BasicSplitPaneUI ui) Creates an instance of `BasicSplitPaneDivider`. Registers this instance for mouse events and mouse dragged events. Parameters ui:BasicSplitPaneUI an instance of `BasicSplitPaneUI`

public BasicSplitPaneDivider(BasicSplitPaneUI ui)

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

Parameters

ui:BasicSplitPaneUI: an instance of BasicSplitPaneUI

Method Detail

createLeftOneTouchButton back to summary

createLeftOneTouchButton	back to summary
protected JButton createLeftOneTouchButton() Creates and return an instance of `JButton` that can be used to collapse the left component in the split pane. Returns:JButton an instance of `JButton`

protected JButton createLeftOneTouchButton()

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

Returns:JButton: an instance of JButton

createRightOneTouchButton back to summary

createRightOneTouchButton	back to summary
protected JButton createRightOneTouchButton() Creates and return an instance of `JButton` that can be used to collapse the right component in the split pane. Returns:JButton an instance of `JButton`

protected JButton createRightOneTouchButton()

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

Returns:JButton: an instance of JButton

dragDividerTo	back to summary
protected void dragDividerTo(int location) Messages the BasicSplitPaneUI with dragDividerTo that this instance is contained in. Parameters location:int a location

dragDividerTo

back to summary

protected void dragDividerTo(int location)

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

Parameters

location:int: a location

finishDraggingTo	back to summary
protected void finishDraggingTo(int location) Messages the BasicSplitPaneUI with finishDraggingTo that this instance is contained in. Parameters location:int a location

finishDraggingTo

back to summary

protected void finishDraggingTo(int location)

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

Parameters

location:int: a location

getBasicSplitPaneUI back to summary

getBasicSplitPaneUI	back to summary
public BasicSplitPaneUI getBasicSplitPaneUI() Returns the `SplitPaneUI` the receiver is currently in. Returns:BasicSplitPaneUI the `SplitPaneUI` the receiver is currently in

public BasicSplitPaneUI getBasicSplitPaneUI()

Returns the SplitPaneUI the receiver is currently in.

Returns:BasicSplitPaneUI: the SplitPaneUI the receiver is currently in

getBorder back to summary

getBorder	back to summary
public Border getBorder() Returns the border of this component or null if no border is currently set. Returns:Border the border object for this component Since 1.3 See Also `setBorder`

public Border getBorder()

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

Returns:Border: the border object for this component
Since: 1.3
See Also: setBorder

getDividerSize	back to summary
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. Returns:int the size of the divider

getDividerSize

back to summary

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.

Returns:int: the size of the divider

getInsets back to summary

getInsets	back to summary
public Insets getInsets() Overrides java.awt.Container.getInsets. If a border has been set on this component, returns the border's insets, else calls super.getInsets. Returns:Insets the value of the insets property. See Also `setBorder`

public Insets getInsets()

Overrides java.awt.Container.getInsets.

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

Returns:Insets: the value of the insets property.
See Also: setBorder

getMinimumSize back to summary

getMinimumSize	back to summary
public Dimension getMinimumSize() Overrides java.awt.Container.getMinimumSize. Returns the minimum size of the divider. Implementation Note In current implementation, if the splitpane is HORIZONTAL_SPLIT, the minimum size is obtained from width of `getDividerSize` pixels and height of 1 pixel If the splitpane is VERTICAL_SPLIT, the minimum size is obtained from height of `getDividerSize` pixels and width of 1 pixel Returns:Dimension a `Dimension` object containing the minimum size of `BasicSplitPaneDivider`

public Dimension getMinimumSize()

Overrides java.awt.Container.getMinimumSize.

Returns the minimum size of the divider.

Implementation Note

In current implementation, if the splitpane is HORIZONTAL_SPLIT, the minimum size is obtained from width of getDividerSize pixels and height of 1 pixel If the splitpane is VERTICAL_SPLIT, the minimum size is obtained from height of getDividerSize pixels and width of 1 pixel

Returns:Dimension: a Dimension object containing the minimum size of BasicSplitPaneDivider

getPreferredSize back to summary

getPreferredSize	back to summary
public Dimension getPreferredSize() Overrides java.awt.Container.getPreferredSize. Returns the preferred size of the divider. Implementation Note In current implementation, if the splitpane is HORIZONTAL_SPLIT, the preferred size is obtained from width of `getDividerSize` pixels and height of 1 pixel If the splitpane is VERTICAL_SPLIT, the preferred size is obtained from height of `getDividerSize` pixels and width of 1 pixel Returns:Dimension a `Dimension` object containing the preferred size of `BasicSplitPaneDivider`

public Dimension getPreferredSize()

Overrides java.awt.Container.getPreferredSize.

Returns the preferred size of the divider.

Implementation Note

In current implementation, if the splitpane is HORIZONTAL_SPLIT, the preferred size is obtained from width of getDividerSize pixels and height of 1 pixel If the splitpane is VERTICAL_SPLIT, the preferred size is obtained from height of getDividerSize pixels and width of 1 pixel

Returns:Dimension: a Dimension object containing the preferred size of BasicSplitPaneDivider

isMouseOver	back to summary
public boolean isMouseOver() Returns whether or not the mouse is currently over the divider Returns:boolean whether or not the mouse is currently over the divider Since 1.5

isMouseOver

back to summary

public boolean isMouseOver()

Returns whether or not the mouse is currently over the divider

Returns:boolean: whether or not the mouse is currently over the divider
Since: 1.5

oneTouchExpandableChanged back to summary

oneTouchExpandableChanged	back to summary
protected void oneTouchExpandableChanged() Messaged when the oneTouchExpandable value of the JSplitPane the divider is contained in changes. If a particular L&F supports this Swing "SplitPane.supportsOneTouchButtons" property it will create the `leftButton` and `rightButton` if they are null and corresponding JSplitPane supports oneTouchExpandable property. Invalidates the corresponding JSplitPane as well.

protected void oneTouchExpandableChanged()

Messaged when the oneTouchExpandable value of the JSplitPane the divider is contained in changes. If a particular L&F supports this Swing "SplitPane.supportsOneTouchButtons" property it will create the leftButton and rightButton if they are null and corresponding JSplitPane supports oneTouchExpandable property. Invalidates the corresponding JSplitPane as well.

paint	back to summary
public void paint(Graphics g) Overrides java.awt.Container.paint. Paints the divider.

paint

back to summary

public void paint(Graphics g)

Overrides java.awt.Container.paint.

Paints the divider.

prepareForDragging	back to summary
protected void prepareForDragging() Message to prepare for dragging. This messages the BasicSplitPaneUI with startDragging.

propertyChange	back to summary
public void propertyChange(PropertyChangeEvent e) Implements java.beans.PropertyChangeListener.propertyChange. Property change event, presumably from the JSplitPane, will message updateOrientation if necessary.

propertyChange

back to summary

public void propertyChange(PropertyChangeEvent e)

Implements java.beans.PropertyChangeListener.propertyChange.

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

revalidateSplitPane	back to summary
private void revalidateSplitPane()

setBasicSplitPaneUI back to summary

setBasicSplitPaneUI	back to summary
public void setBasicSplitPaneUI(BasicSplitPaneUI newUI) Sets the `SplitPaneUI` that is using the receiver. Parameters newUI:BasicSplitPaneUI the new `SplitPaneUI`

public void setBasicSplitPaneUI(BasicSplitPaneUI newUI)

Sets the SplitPaneUI that is using the receiver.

Parameters

newUI:BasicSplitPaneUI: the new SplitPaneUI

setBorder	back to summary
public void setBorder(Border border) Sets the border of this component. Parameters border:Border a new border Since 1.3

setBorder

back to summary

public void setBorder(Border border)

Sets the border of this component.

Parameters

border:Border: a new border

Since

1.3

setDividerSize back to summary

setDividerSize	back to summary
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`. Divider sizes `newSize < 0` are ignored. Parameters newSize:int a new size

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. Divider sizes newSize < 0 are ignored.

Parameters

newSize:int: a new size

setEnabled back to summary

setEnabled	back to summary
public void setEnabled(boolean enabled) Overrides java.awt.Component.setEnabled. Doc from java.awt.Component.setEnabled. Enables or disables this component, depending on the value of the parameter `b`. An enabled component can respond to user input and generate events. Components are enabled initially by default. Note Disabling a lightweight component does not prevent it from receiving MouseEvents. Note Disabling a heavyweight container prevents all components in this container from receiving any input events. But disabling a lightweight container affects only this container. Annotations @Override

public void setEnabled(boolean enabled)

Overrides java.awt.Component.setEnabled.

Doc from java.awt.Component.setEnabled.

Enables or disables this component, depending on the value of the parameter b. An enabled component can respond to user input and generate events. Components are enabled initially by default.

Note

Disabling a lightweight component does not prevent it from receiving MouseEvents.

Note

Disabling a heavyweight container prevents all components in this container from receiving any input events. But disabling a lightweight container affects only this container.

Annotations

@Override

setMouseOver	back to summary
protected void setMouseOver(boolean mouseOver) Sets whether or not the mouse is currently over the divider. Parameters mouseOver:boolean whether or not the mouse is currently over the divider Since 1.5

setMouseOver

back to summary

protected void setMouseOver(boolean mouseOver)

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

Parameters

mouseOver:boolean: whether or not the mouse is currently over the divider

Since

1.5

javax.swing.plaf.basic back to summary

protected Class BasicSplitPaneDivider.DividerLayout

Class Inheritance

extends Object
implements LayoutManager

java.lang.Object
javax.swing.plaf.basic.BasicSplitPaneDivider.DividerLayout

All Implemented Interfaces

java.awt.LayoutManager

Used to layout a BasicSplitPaneDivider. Layout for the divider involves appropriately moving the left/right buttons around.

Constructor Summary

Access	Constructor and Description
protected	DividerLayout() Constructs a `DividerLayout`.

Method Summary

Modifier and Type	Method and Description
public void	addLayoutComponent(String string, Component c) Implements java.awt.LayoutManager.addLayoutComponent. If the layout manager uses a per-component string, adds the component `comp` to the layout, associating it with the string specified by `name`.
public void	layoutContainer(Container c) Implements java.awt.LayoutManager.layoutContainer. Lays out the specified container.
public Dimension	minimumLayoutSize(Container c) Implements java.awt.LayoutManager.minimumLayoutSize. Calculates the minimum size dimensions for the specified container, given the components it contains.
public Dimension	preferredLayoutSize(Container c) Implements java.awt.LayoutManager.preferredLayoutSize. Calculates the preferred size dimensions for the specified container, given the components it contains.
public void	removeLayoutComponent(Component c) Implements java.awt.LayoutManager.removeLayoutComponent. Removes the specified component from the layout.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

DividerLayout	back to summary
protected DividerLayout() Constructs a `DividerLayout`.

Method Detail

addLayoutComponent back to summary

addLayoutComponent	back to summary
public void addLayoutComponent(String string, Component c) Implements java.awt.LayoutManager.addLayoutComponent. Doc from java.awt.LayoutManager.addLayoutComponent. If the layout manager uses a per-component string, adds the component `comp` to the layout, associating it with the string specified by `name`.

public void addLayoutComponent(String string, Component c)

Implements java.awt.LayoutManager.addLayoutComponent.

Doc from java.awt.LayoutManager.addLayoutComponent.

If the layout manager uses a per-component string, adds the component comp to the layout, associating it with the string specified by name.

layoutContainer	back to summary
public void layoutContainer(Container c) Implements java.awt.LayoutManager.layoutContainer. Doc from java.awt.LayoutManager.layoutContainer. Lays out the specified container.

layoutContainer

back to summary

public void layoutContainer(Container c)

Implements java.awt.LayoutManager.layoutContainer.

Doc from java.awt.LayoutManager.layoutContainer.

Lays out the specified container.

minimumLayoutSize	back to summary
public Dimension minimumLayoutSize(Container c) Implements java.awt.LayoutManager.minimumLayoutSize. Doc from java.awt.LayoutManager.minimumLayoutSize. Calculates the minimum size dimensions for the specified container, given the components it contains.

minimumLayoutSize

back to summary

public Dimension minimumLayoutSize(Container c)

Implements java.awt.LayoutManager.minimumLayoutSize.

Doc from java.awt.LayoutManager.minimumLayoutSize.

Calculates the minimum size dimensions for the specified container, given the components it contains.

preferredLayoutSize	back to summary
public Dimension preferredLayoutSize(Container c) Implements java.awt.LayoutManager.preferredLayoutSize. Doc from java.awt.LayoutManager.preferredLayoutSize. Calculates the preferred size dimensions for the specified container, given the components it contains.

preferredLayoutSize

back to summary

public Dimension preferredLayoutSize(Container c)

Implements java.awt.LayoutManager.preferredLayoutSize.

Doc from java.awt.LayoutManager.preferredLayoutSize.

Calculates the preferred size dimensions for the specified container, given the components it contains.

removeLayoutComponent	back to summary
public void removeLayoutComponent(Component c) Implements java.awt.LayoutManager.removeLayoutComponent. Doc from java.awt.LayoutManager.removeLayoutComponent. Removes the specified component from the layout.

removeLayoutComponent

back to summary

public void removeLayoutComponent(Component c)

Implements java.awt.LayoutManager.removeLayoutComponent.

Doc from java.awt.LayoutManager.removeLayoutComponent.

Removes the specified component from the layout.

javax.swing.plaf.basic back to summary

protected Class BasicSplitPaneDivider.DragController

Class Inheritance

extends Object

java.lang.Object
javax.swing.plaf.basic.BasicSplitPaneDivider.DragController

Known Direct Subclasses

javax.swing.plaf.basic.BasicSplitPaneDivider.VerticalDragController

Handles the events during a dragging session for a HORIZONTAL_SPLIT oriented split pane. This continually messages dragDividerTo and then when done messages finishDraggingTo. When an instance is created it should be messaged with isValid to insure that dragging can happen (dragging won't be allowed if the two views can not be resized).

Warning

Serialized objects of this class will not be compatible with future Swing releases. The current serialization support is appropriate for short term storage or RMI between applications running the same version of Swing. As of 1.4, support for long term storage of all JavaBeans has been added to the java.beans package. Please see java.beans.XMLEncoder.

Field Summary

Modifier and Type	Field and Description
pack-priv int	initialX Initial location of the divider.
pack-priv int	maxX Maximum and minimum positions to drag to.
pack-priv int	minX Maximum and minimum positions to drag to.
pack-priv int	offset Initial location the mouse down happened at.

Constructor Summary

Access	Constructor and Description
protected	DragController(MouseEvent a mouse event e) Constructs a new instance of `DragController`.

Method Summary

Modifier and Type	Method and Description
protected void	completeDrag(int an X coordinate x, int an Y coordinate y) Messages finishDraggingTo with the new location for the mouse event.
protected void	completeDrag(MouseEvent a mouse event e) Messages finishDraggingTo with the new location for the mouse event.
protected void	continueDrag(int an X coordinate newX, int an Y coordinate newY) Messages dragDividerTo with the new location for the mouse event.
protected void	continueDrag(MouseEvent a mouse event e) Messages dragDividerTo with the new location for the mouse event.
protected int	Returns: the X argument getNeededLocation(int an X coordinate x, int an Y coordinate y) Returns the x argument, since this is used for horizontal splits.
protected boolean	Returns: `true` if the dragging session is valid isValid() Returns `true` if the dragging session is valid.
protected int	Returns: the new position positionForMouseEvent(MouseEvent a mouse event e) Returns the new position to put the divider at based on the passed in MouseEvent.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

initialX	back to summary
pack-priv int initialX Initial location of the divider.

maxX	back to summary
pack-priv int maxX Maximum and minimum positions to drag to.

minX	back to summary
pack-priv int minX Maximum and minimum positions to drag to.

offset	back to summary
pack-priv int offset Initial location the mouse down happened at.

Constructor Detail

DragController back to summary

protected DragController(MouseEvent e)

Constructs a new instance of DragController.

Parameters

e:MouseEvent: a mouse event

Method Detail

completeDrag

back to summary

protected void completeDrag(int x, int y)

Messages finishDraggingTo with the new location for the mouse event.

Parameters

x:int: an X coordinate
y:int: an Y coordinate

completeDrag

back to summary

protected void completeDrag(MouseEvent e)

Messages finishDraggingTo with the new location for the mouse event.

Parameters

e:MouseEvent: a mouse event

continueDrag

back to summary

protected void continueDrag(int newX, int newY)

Messages dragDividerTo with the new location for the mouse event.

Parameters

newX:int: an X coordinate
newY:int: an Y coordinate

continueDrag

back to summary

protected void continueDrag(MouseEvent e)

Messages dragDividerTo with the new location for the mouse event.

Parameters

e:MouseEvent: a mouse event

getNeededLocation

back to summary

protected int getNeededLocation(int x, int y)

Returns the x argument, since this is used for horizontal splits.

Parameters

x:int: an X coordinate
y:int: an Y coordinate

Returns:int

the X argument

isValid back to summary

protected boolean isValid()

Returns true if the dragging session is valid.

Returns:boolean: true if the dragging session is valid

positionForMouseEvent

back to summary

protected int positionForMouseEvent(MouseEvent e)

Returns the new position to put the divider at based on the passed in MouseEvent.

Parameters

e:MouseEvent: a mouse event

Returns:int

the new position

javax.swing.plaf.basic back to summary

protected Class BasicSplitPaneDivider.MouseHandler

Class Inheritance

extends MouseAdapter
implements MouseMotionListener

java.lang.Object
java.awt.event.MouseAdapter
javax.swing.plaf.basic.BasicSplitPaneDivider.MouseHandler

All Implemented Interfaces

java.awt.event.MouseMotionListener, java.util.EventListener

Known Direct Subclasses

com.sun.java.swing.plaf.motif.MotifSplitPaneDivider.MotifMouseHandler

MouseHandler is responsible for converting mouse events (released, dragged...) into the appropriate DragController methods.

Constructor Summary

Access	Constructor and Description
protected	MouseHandler() Constructs a `MouseHandler`.

Method Summary

Modifier and Type	Method and Description
public void	mouseDragged(MouseEvent e) Overrides java.awt.event.MouseAdapter.mouseDragged. Implements java.awt.event.MouseMotionListener.mouseDragged. If dragger is not null it is messaged with continueDrag.
public void	mouseEntered(MouseEvent MouseEvent describing the details of the enter event. e) Overrides java.awt.event.MouseAdapter.mouseEntered. Implements java.awt.event.MouseListener.mouseEntered. Invoked when the mouse enters a component.
public void	mouseExited(MouseEvent MouseEvent describing the details of the exit event. e) Overrides java.awt.event.MouseAdapter.mouseExited. Implements java.awt.event.MouseListener.mouseExited. Invoked when the mouse exits a component.
public void	mouseMoved(MouseEvent e) Overrides java.awt.event.MouseAdapter.mouseMoved. Implements java.awt.event.MouseMotionListener.mouseMoved. Resets the cursor based on the orientation.
public void	mousePressed(MouseEvent e) Overrides java.awt.event.MouseAdapter.mousePressed. Implements java.awt.event.MouseListener.mousePressed. Starts the dragging session by creating the appropriate instance of DragController.
public void	mouseReleased(MouseEvent e) Overrides java.awt.event.MouseAdapter.mouseReleased. Implements java.awt.event.MouseListener.mouseReleased. If dragger is not null it is messaged with completeDrag.

Inherited from java.awt.event.MouseAdapter:: mouseClicked mouseWheelMoved

Constructor Detail

MouseHandler	back to summary
protected MouseHandler() Constructs a `MouseHandler`.

Method Detail

mouseDragged

back to summary

public void mouseDragged(MouseEvent e)

Overrides java.awt.event.MouseAdapter.mouseDragged.

Implements java.awt.event.MouseMotionListener.mouseDragged.

If dragger is not null it is messaged with continueDrag.

mouseEntered

back to summary

public void mouseEntered(MouseEvent e)

Overrides java.awt.event.MouseAdapter.mouseEntered.

Implements java.awt.event.MouseListener.mouseEntered.

Invoked when the mouse enters a component.

Parameters

e:MouseEvent: MouseEvent describing the details of the enter event.

Since

1.5

mouseExited

back to summary

public void mouseExited(MouseEvent e)

Overrides java.awt.event.MouseAdapter.mouseExited.

Implements java.awt.event.MouseListener.mouseExited.

Invoked when the mouse exits a component.

Parameters

e:MouseEvent: MouseEvent describing the details of the exit event.

Since

1.5

mouseMoved

back to summary

public void mouseMoved(MouseEvent e)

Overrides java.awt.event.MouseAdapter.mouseMoved.

Implements java.awt.event.MouseMotionListener.mouseMoved.

Resets the cursor based on the orientation.

mousePressed

back to summary

public void mousePressed(MouseEvent e)

Overrides java.awt.event.MouseAdapter.mousePressed.

Implements java.awt.event.MouseListener.mousePressed.

Starts the dragging session by creating the appropriate instance of DragController.

mouseReleased

back to summary

public void mouseReleased(MouseEvent e)

Overrides java.awt.event.MouseAdapter.mouseReleased.

Implements java.awt.event.MouseListener.mouseReleased.

If dragger is not null it is messaged with completeDrag.

javax.swing.plaf.basic back to summary

private Class BasicSplitPaneDivider.OneTouchActionHandler

Class Inheritance

extends Object
implements ActionListener

java.lang.Object
javax.swing.plaf.basic.BasicSplitPaneDivider.OneTouchActionHandler

All Implemented Interfaces

java.awt.event.ActionListener, java.util.EventListener

Listeners installed on the one touch expandable buttons.

Field Summary

Modifier and Type	Field and Description
private boolean	toMinimum True indicates the resize should go the minimum (top or left) vs false which indicates the resize should go to the maximum.

Constructor Summary

Access	Constructor and Description
pack-priv	OneTouchActionHandler(boolean toMinimum)

Method Summary

Modifier and Type	Method and Description
public void	actionPerformed(ActionEvent e) Implements java.awt.event.ActionListener.actionPerformed. Invoked when an action occurs.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

toMinimum	back to summary
private boolean toMinimum True indicates the resize should go the minimum (top or left) vs false which indicates the resize should go to the maximum.

Constructor Detail

OneTouchActionHandler	back to summary
pack-priv OneTouchActionHandler(boolean toMinimum)

Method Detail

actionPerformed

back to summary

public void actionPerformed(ActionEvent e)

Implements java.awt.event.ActionListener.actionPerformed.

Doc from java.awt.event.ActionListener.actionPerformed.

Invoked when an action occurs.

javax.swing.plaf.basic back to summary

protected Class BasicSplitPaneDivider.VerticalDragController

Class Inheritance

extends DragController

java.lang.Object
javax.swing.plaf.basic.BasicSplitPaneDivider.DragController
javax.swing.plaf.basic.BasicSplitPaneDivider.VerticalDragController

Handles the events during a dragging session for a VERTICAL_SPLIT oriented split pane. This continually messages dragDividerTo and then when done messages finishDraggingTo. When an instance is created it should be messaged with isValid to insure that dragging can happen (dragging won't be allowed if the two views can not be resized).

Field Summary

Inherited from javax.swing.plaf.basic.BasicSplitPaneDivider.DragController:: initialX maxX minX offset

Constructor Summary

Access	Constructor and Description
protected	VerticalDragController(MouseEvent a mouse event e) Constructs a new instance of `VerticalDragController`.

Method Summary

Modifier and Type	Method and Description
protected int	getNeededLocation(int x, int y) Overrides javax.swing.plaf.basic.BasicSplitPaneDivider.DragController.getNeededLocation. Returns the y argument, since this is used for vertical splits.
protected int	positionForMouseEvent(MouseEvent e) Overrides javax.swing.plaf.basic.BasicSplitPaneDivider.DragController.positionForMouseEvent. Returns the new position to put the divider at based on the passed in MouseEvent.

Inherited from javax.swing.plaf.basic.BasicSplitPaneDivider.DragController:: completeDrag completeDrag continueDrag continueDrag isValid

Constructor Detail

VerticalDragController back to summary

protected VerticalDragController(MouseEvent e)

Constructs a new instance of VerticalDragController.

Parameters

e:MouseEvent: a mouse event

Method Detail

getNeededLocation

back to summary

protected int getNeededLocation(int x, int y)

Overrides javax.swing.plaf.basic.BasicSplitPaneDivider.DragController.getNeededLocation.

Returns the y argument, since this is used for vertical splits.

positionForMouseEvent

back to summary

protected int positionForMouseEvent(MouseEvent e)

Overrides javax.swing.plaf.basic.BasicSplitPaneDivider.DragController.positionForMouseEvent.

Returns the new position to put the divider at based on the passed in MouseEvent.

public Class BasicSplitPaneDivider

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

protected Class BasicSplitPaneDivider.DividerLayout

Constructor Summary

Method Summary

Constructor Detail

Method Detail

protected Class BasicSplitPaneDivider.DragController

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

protected Class BasicSplitPaneDivider.MouseHandler

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private Class BasicSplitPaneDivider.OneTouchActionHandler

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

protected Class BasicSplitPaneDivider.VerticalDragController

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail