Class JSplitPane
- All Implemented Interfaces:
ImageObserver, MenuContainer, Serializable, Accessible
@JavaBean(defaultProperty="UI") public class JSplitPane extends JComponent implements Accessible
JSplitPane is used to divide two (and only two) Components. The two Components are graphically divided based on the look and feel implementation, and the two Components can then be interactively resized by the user. Information on using JSplitPane is in How to Use Split Panes in The Java Tutorial. The two Components in a split pane can be aligned left to right using JSplitPane.HORIZONTAL_SPLIT, or top to bottom using JSplitPane.VERTICAL_SPLIT. The preferred way to change the size of the Components is to invoke setDividerLocation where location is either the new x or y position, depending on the orientation of the JSplitPane.
To resize the Components to their preferred sizes invoke resetToPreferredSizes.
When the user is resizing the Components the minimum size of the Components is used to determine the maximum/minimum position the Components can be set to. If the minimum size of the two components is greater than the size of the split pane the divider will not allow you to resize it. To alter the minimum size of a JComponent, see JComponent.setMinimumSize(Dimension).
When the user resizes the split pane the new space is distributed between the two components based on the resizeWeight property. A value of 0, the default, indicates the right/bottom component gets all the space, where as a value of 1 indicates the left/top component gets all the space.
Warning: Swing is not thread safe. For more information see Swing's Threading Policy.
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 XMLEncoder.
- Since:
- 1.2
- See Also:
Nested Class Summary
| Modifier and Type | Class | Description |
|---|---|---|
protected class |
JSplitPane.AccessibleJSplitPane |
This class implements accessibility support for the JSplitPane class. |
Nested classes/interfaces declared in class JComponent
JComponent.AccessibleJComponent | Modifier and Type | Class | Description |
|---|---|---|
class |
JComponent.AccessibleJComponent |
Inner class of JComponent used to provide default support for accessibility. |
Nested classes/interfaces declared in class Container
Container.AccessibleAWTContainer | Modifier and Type | Class | Description |
|---|---|---|
protected class |
Container.AccessibleAWTContainer |
Inner class of Container used to provide default support for accessibility. |
Nested classes/interfaces declared in class Component
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy | Modifier and Type | Class | Description |
|---|---|---|
protected class |
Component.AccessibleAWTComponent |
Inner class of Component used to provide default support for accessibility. |
static enum |
Component.BaselineResizeBehavior |
Enumeration of the common ways the baseline of a component can change as the size changes. |
protected class |
Component.BltBufferStrategy |
Inner class for blitting offscreen surfaces to a component. |
protected class |
Component.FlipBufferStrategy |
Inner class for flipping buffers on a component. |
Field Summary
| Modifier and Type | Field | Description |
|---|---|---|
static final String |
BOTTOM |
Used to add a Component below the other Component. |
static final String |
CONTINUOUS_LAYOUT_PROPERTY |
Bound property name for continuousLayout. |
protected boolean |
continuousLayout |
Whether or not the views are continuously redisplayed while resizing. |
static final String |
DIVIDER |
Used to add a Component that will represent the divider. |
static final String |
DIVIDER_LOCATION_PROPERTY |
Bound property for the dividerLocation. |
static final String |
DIVIDER_SIZE_PROPERTY |
Bound property name for border. |
protected int |
dividerSize |
Size of the divider. |
static final int |
HORIZONTAL_SPLIT |
Horizontal split indicates the Components are split along the x axis. |
static final String |
LAST_DIVIDER_LOCATION_PROPERTY |
Bound property for lastLocation. |
protected int |
lastDividerLocation |
Previous location of the split pane. |
static final String |
LEFT |
Used to add a Component to the left of the other Component. |
protected Component |
leftComponent |
The left or top component. |
static final String |
ONE_TOUCH_EXPANDABLE_PROPERTY |
Bound property for oneTouchExpandable. |
protected boolean |
oneTouchExpandable |
Is a little widget provided to quickly expand/collapse the split pane? |
protected int |
orientation |
How the views are split. |
static final String |
ORIENTATION_PROPERTY |
Bound property name for orientation (horizontal or vertical). |
static final String |
RESIZE_WEIGHT_PROPERTY |
Bound property for weight. |
static final String |
RIGHT |
Used to add a Component to the right of the other Component. |
protected Component |
rightComponent |
The right or bottom component. |
static final String |
TOP |
Used to add a Component above the other Component. |
static final int |
VERTICAL_SPLIT |
Vertical split indicates the Components are split along the y axis. |
Fields declared in class JComponent
listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW | Modifier and Type | Field | Description |
|---|---|---|
protected EventListenerList |
listenerList |
A list of event listeners for this component. |
static final String |
TOOL_TIP_TEXT_KEY |
The comment to display when the cursor is over the component, also known as a "value tip", "flyover help", or "flyover label". |
protected ComponentUI |
ui |
The look and feel delegate for this component. |
static final int |
UNDEFINED_CONDITION |
Constant used by some of the APIs to mean that no condition is defined. |
static final int |
WHEN_ANCESTOR_OF_FOCUSED_COMPONENT |
Constant used for registerKeyboardAction that means that the command should be invoked when the receiving component is an ancestor of the focused component or is itself the focused component. |
static final int |
WHEN_FOCUSED |
Constant used for registerKeyboardAction that means that the command should be invoked when the component has the focus. |
static final int |
WHEN_IN_FOCUSED_WINDOW |
Constant used for registerKeyboardAction that means that the command should be invoked when the receiving component is in the window that has the focus or is itself the focused component. |
Fields declared in class Component
accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT | Modifier and Type | Field | Description |
|---|---|---|
protected AccessibleContext |
accessibleContext |
The AccessibleContext associated with this Component. |
static final float |
BOTTOM_ALIGNMENT |
Ease-of-use constant for getAlignmentY. |
static final float |
CENTER_ALIGNMENT |
Ease-of-use constant for getAlignmentY and getAlignmentX. |
static final float |
LEFT_ALIGNMENT |
Ease-of-use constant for getAlignmentX. |
static final float |
RIGHT_ALIGNMENT |
Ease-of-use constant for getAlignmentX. |
static final float |
TOP_ALIGNMENT |
Ease-of-use constant for getAlignmentY(). |
Fields declared in interface ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH | Modifier and Type | Field | Description |
|---|---|---|
static final int |
ABORT |
This flag in the infoflags argument to imageUpdate indicates that an image which was being tracked asynchronously was aborted before production was complete. |
static final int |
ALLBITS |
This flag in the infoflags argument to imageUpdate indicates that a static image which was previously drawn is now complete and can be drawn again in its final form. |
static final int |
ERROR |
This flag in the infoflags argument to imageUpdate indicates that an image which was being tracked asynchronously has encountered an error. |
static final int |
FRAMEBITS |
This flag in the infoflags argument to imageUpdate indicates that another complete frame of a multi-frame image which was previously drawn is now available to be drawn again. |
static final int |
HEIGHT |
This flag in the infoflags argument to imageUpdate indicates that the height of the base image is now available and can be taken from the height argument to the imageUpdate callback method. |
static final int |
PROPERTIES |
This flag in the infoflags argument to imageUpdate indicates that the properties of the image are now available. |
static final int |
SOMEBITS |
This flag in the infoflags argument to imageUpdate indicates that more pixels needed for drawing a scaled variation of the image are available. |
static final int |
WIDTH |
This flag in the infoflags argument to imageUpdate indicates that the width of the base image is now available and can be taken from the width argument to the imageUpdate callback method. |
Constructor Summary
| Constructor | Description |
|---|---|
JSplitPane() |
Creates a new JSplitPane configured to arrange the child components side-by-side horizontally, using two buttons for the components. |
JSplitPane |
Creates a new JSplitPane configured with the specified orientation. |
JSplitPane |
Creates a new JSplitPane with the specified orientation and redrawing style. |
JSplitPane |
Creates a new JSplitPane with the specified orientation and redrawing style, and with the specified components. |
JSplitPane |
Creates a new JSplitPane with the specified orientation and the specified components. |
Method Summary
| Modifier and Type | Method | Description |
|---|---|---|
protected void |
addImpl |
Adds the specified component to this split pane. |
AccessibleContext |
getAccessibleContext() |
Gets the AccessibleContext associated with this JSplitPane. |
Component |
getBottomComponent() |
Returns the component below, or to the right of the divider. |
int |
getDividerLocation() |
Returns the last value passed to setDividerLocation. |
int |
getDividerSize() |
Returns the size of the divider. |
int |
getLastDividerLocation() |
Returns the last location the divider was at. |
Component |
getLeftComponent() |
Returns the component to the left (or above) the divider. |
int |
getMaximumDividerLocation() |
Returns the maximum location of the divider from the look and feel implementation. |
int |
getMinimumDividerLocation() |
Returns the minimum location of the divider from the look and feel implementation. |
int |
getOrientation() |
Returns the orientation. |
double |
getResizeWeight() |
Returns the number that determines how extra space is distributed. |
Component |
getRightComponent() |
Returns the component to the right (or below) the divider. |
Component |
getTopComponent() |
Returns the component above, or to the left of the divider. |
SplitPaneUI |
getUI() |
Returns the SplitPaneUI that is providing the current look and feel. |
String |
getUIClassID() |
Returns the name of the L&F class that renders this component. |
boolean |
isContinuousLayout() |
Gets the continuousLayout property. |
boolean |
isOneTouchExpandable() |
Gets the oneTouchExpandable property. |
boolean |
isValidateRoot() |
Returns true, so that calls to revalidate on any descendant of this JSplitPane will cause a request to be queued that will validate the JSplitPane and all its descendants. |
protected void |
paintChildren |
Subclassed to message the UI with finishedPaintingChildren after super has been messaged, as well as painting the border. |
protected String |
paramString() |
Returns a string representation of this JSplitPane. |
void |
remove |
Removes the Component at the specified index. |
void |
remove |
Removes the child component, component from the pane. |
void |
removeAll() |
Removes all the child components from the split pane. |
void |
resetToPreferredSizes() |
Lays out the JSplitPane layout based on the preferred size of the children components. |
void |
setBottomComponent |
Sets the component below, or to the right of the divider. |
void |
setComponentOrientation |
Sets the language-sensitive orientation that is to be used to order the elements or text within this component. |
void |
setContinuousLayout |
Sets the value of the continuousLayout property, which must be true for the child components to be continuously redisplayed and laid out during user intervention. |
void |
setDividerLocation |
Sets the divider location as a percentage of the JSplitPane's size. |
void |
setDividerLocation |
Sets the location of the divider. |
void |
setDividerSize |
Sets the size of the divider. |
void |
setEnabled |
Sets whether or not this component is enabled. |
void |
setLastDividerLocation |
Sets the last location the divider was at to newLastLocation. |
void |
setLeftComponent |
Sets the component to the left (or above) the divider. |
void |
setOneTouchExpandable |
Sets the value of the oneTouchExpandable property, which must be true for the JSplitPane to provide a UI widget on the divider to quickly expand/collapse the divider. |
void |
setOrientation |
Sets the orientation, or how the splitter is divided. |
void |
setResizeWeight |
Specifies how to distribute extra space when the size of the split pane changes. |
void |
setRightComponent |
Sets the component to the right (or below) the divider. |
void |
setTopComponent |
Sets the component above, or to the left of the divider. |
void |
setUI |
Sets the L&F object that renders this component. |
void |
updateUI() |
Notification from the UIManager that the L&F has changed. |
Methods declared in class JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, paint, paintBorder, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update | Modifier and Type | Method | Description |
|---|---|---|
void |
addAncestorListener |
Registers listener so that it will receive AncestorEvents when it or any of its ancestors move or are made visible or invisible. |
void |
addNotify() |
Notifies this component that it now has a parent component. |
void |
addVetoableChangeListener |
Adds a VetoableChangeListener to the listener list. |
void |
computeVisibleRect |
Returns the Component's "visible rect rectangle" - the intersection of the visible rectangles for this component and all of its ancestors. |
boolean |
contains |
Gives the UI delegate an opportunity to define the precise shape of this component for the sake of mouse processing. |
JToolTip |
createToolTip() |
Returns the instance of JToolTip that should be used to display the tooltip. |
void |
disable() |
Deprecated. |
void |
enable() |
Deprecated. As of JDK version 1.1, replaced by java.awt.Component.setEnabled(boolean). |
void |
firePropertyChange |
Support for reporting bound property changes for boolean properties. |
void |
firePropertyChange |
Support for reporting bound property changes for integer properties. |
protected void |
fireVetoableChange |
Supports reporting constrained property changes. |
ActionListener |
getActionForKeyStroke |
Returns the object that will perform the action registered for a given keystroke. |
final ActionMap |
getActionMap() |
Returns the ActionMap used to determine what Action to fire for particular KeyStroke binding. |
float |
getAlignmentX() |
Overrides Container.getAlignmentX to return the horizontal alignment. |
float |
getAlignmentY() |
Overrides Container.getAlignmentY to return the vertical alignment. |
AncestorListener[] |
getAncestorListeners() |
Returns an array of all the ancestor listeners registered on this component. |
boolean |
getAutoscrolls() |
Gets the autoscrolls property. |
int |
getBaseline |
Returns the baseline. |
Component.BaselineResizeBehavior |
getBaselineResizeBehavior() |
Returns an enum indicating how the baseline of the component changes as the size changes. |
Border |
getBorder() |
Returns the border of this component or null if no border is currently set. |
Rectangle |
getBounds |
Stores the bounds of this component into "return value" rv and returns rv. |
final Object |
getClientProperty |
Returns the value of the property with the specified key. |
protected Graphics |
getComponentGraphics |
Returns the graphics object used to paint this component. |
JPopupMenu |
getComponentPopupMenu() |
Returns JPopupMenu that assigned for this component. |
int |
getConditionForKeyStroke |
Returns the condition that determines whether a registered action occurs in response to the specified keystroke. |
int |
getDebugGraphicsOptions() |
Returns the state of graphics debugging. |
static Locale |
getDefaultLocale() |
Returns the default locale used to initialize each JComponent's locale property upon creation. |
FontMetrics |
getFontMetrics |
Gets the FontMetrics for the specified Font. |
Graphics |
getGraphics() |
Returns this component's graphics context, which lets you draw on a component. |
int |
getHeight() |
Returns the current height of this component. |
boolean |
getInheritsPopupMenu() |
Returns true if the JPopupMenu should be inherited from the parent. |
final InputMap |
getInputMap() |
Returns the InputMap that is used when the component has focus. |
final InputMap |
getInputMap |
Returns the InputMap that is used during condition. |
InputVerifier |
getInputVerifier() |
Returns the input verifier for this component. |
Insets |
getInsets() |
If a border has been set on this component, returns the border's insets; otherwise calls super.getInsets. |
Insets |
getInsets |
Returns an Insets object containing this component's inset values. |
<T extends EventListener> |
getListeners |
Returns an array of all the objects currently registered as FooListeners upon this JComponent. |
Point |
getLocation |
Stores the x,y origin of this component into "return value" rv and returns rv. |
Dimension |
getMaximumSize() |
If the maximum size has been set to a non- null value just returns it. |
Dimension |
getMinimumSize() |
If the minimum size has been set to a non- null value just returns it. |
Component |
getNextFocusableComponent() |
Deprecated. As of 1.4, replaced by FocusTraversalPolicy. |
Point |
getPopupLocation |
Returns the preferred location to display the popup menu in this component's coordinate system. |
Dimension |
getPreferredSize() |
If the preferredSize has been set to a non-null value just returns it. |
KeyStroke[] |
getRegisteredKeyStrokes() |
Returns the KeyStrokes that will initiate registered actions. |
JRootPane |
getRootPane() |
Returns the JRootPane ancestor for this component. |
Dimension |
getSize |
Stores the width/height of this component into "return value" rv and returns rv. |
Point |
getToolTipLocation |
Returns the tooltip location in this component's coordinate system. |
String |
getToolTipText() |
Returns the tooltip string that has been set with setToolTipText. |
String |
getToolTipText |
Returns the string to be used as the tooltip for event. |
Container |
getTopLevelAncestor() |
Returns the top-level ancestor of this component (the containing Window) or null if this component has not been added to any container. |
TransferHandler |
getTransferHandler() |
Gets the transferHandler property. |
boolean |
getVerifyInputWhenFocusTarget() |
Returns the value that indicates whether the input verifier for the current focus owner will be called before this component requests focus. |
VetoableChangeListener[] |
getVetoableChangeListeners() |
Returns an array of all the vetoable change listeners registered on this component. |
Rectangle |
getVisibleRect() |
Returns the Component's "visible rectangle" - the intersection of this component's visible rectangle, new Rectangle(0, 0, getWidth(), getHeight()), and all of its ancestors' visible rectangles. |
int |
getWidth() |
Returns the current width of this component. |
int |
getX() |
Returns the current x coordinate of the component's origin. |
int |
getY() |
Returns the current y coordinate of the component's origin. |
void |
grabFocus() |
Requests that this Component get the input focus, and that this Component's top-level ancestor become the focused Window. |
void |
hide() |
Deprecated. |
boolean |
isDoubleBuffered() |
Returns whether this component should use a buffer to paint. |
static boolean |
isLightweightComponent |
Returns true if this component is lightweight, that is, if it doesn't have a native window system peer. |
boolean |
isManagingFocus() |
Deprecated. As of 1.4, replaced by Component.setFocusTraversalKeys(int, Set) and Container.setFocusCycleRoot(boolean). |
boolean |
isOpaque() |
Returns true if this component is completely opaque. |
boolean |
isOptimizedDrawingEnabled() |
Returns true if this component tiles its children -- that is, if it can guarantee that the children will not overlap. |
final boolean |
isPaintingForPrint() |
Returns true if the current painting operation on this component is part of a print operation. |
protected boolean |
isPaintingOrigin() |
Returns true if a paint triggered on a child component should cause painting to originate from this Component, or one of its ancestors. |
boolean |
isPaintingTile() |
Returns true if the component is currently painting a tile. |
boolean |
isRequestFocusEnabled() |
Returns true if this JComponent should get focus; otherwise returns false. |
void |
paint |
Invoked by Swing to draw components. |
protected void |
paintBorder |
Paints the component's border. |
protected void |
paintComponent |
Calls the UI delegate's paint method, if the UI delegate is non- null. |
void |
paintImmediately |
Paints the specified region in this component and all of its descendants that overlap the region, immediately. |
void |
paintImmediately |
Paints the specified region now. |
void |
print |
Invoke this method to print the component to the specified Graphics. |
void |
printAll |
Invoke this method to print the component. |
protected void |
printBorder |
Prints the component's border. |
protected void |
printChildren |
Prints this component's children. |
protected void |
printComponent |
This is invoked during a printing operation. |
protected void |
processComponentKeyEvent |
Processes any key events that the component itself recognizes. |
protected boolean |
processKeyBinding |
Invoked to process the key bindings for ks as the result of the KeyEvent e. |
protected void |
processKeyEvent |
Overrides processKeyEvent to process events. |
protected void |
processMouseEvent |
Processes mouse events occurring on this component by dispatching them to any registered MouseListener objects, refer to Component.processMouseEvent(MouseEvent) for a complete description of this method. |
protected void |
processMouseMotionEvent |
Processes mouse motion events, such as MouseEvent.MOUSE_DRAGGED. |
final void |
putClientProperty |
Adds an arbitrary key/value "client property" to this component. |
void |
registerKeyboardAction |
This method is now obsolete, please use a combination of getActionMap() and getInputMap() for similar behavior. |
void |
registerKeyboardAction |
This method is now obsolete, please use a combination of getActionMap() and getInputMap() for similar behavior. |
void |
removeAncestorListener |
Unregisters listener so that it will no longer receive AncestorEvents. |
void |
removeNotify() |
Notifies this component that it no longer has a parent component. |
void |
removeVetoableChangeListener |
Removes a VetoableChangeListener from the listener list. |
void |
repaint |
Adds the specified region to the dirty region list if the component is showing. |
void |
repaint |
Adds the specified region to the dirty region list if the component is showing. |
boolean |
requestDefaultFocus() |
Deprecated. As of 1.4, replaced by FocusTraversalPolicy.getDefaultComponent(Container).requestFocus()
|
void |
requestFocus() |
Requests that this Component gets the input focus. |
boolean |
requestFocus |
Requests that this Component gets the input focus. |
boolean |
requestFocusInWindow() |
Requests that this Component gets the input focus. |
protected boolean |
requestFocusInWindow |
Requests that this Component gets the input focus. |
void |
resetKeyboardActions() |
Unregisters all the bindings in the first tier InputMaps and ActionMap. |
void |
reshape |
Deprecated. As of JDK 5, replaced by Component.setBounds(int, int, int, int). |
void |
revalidate() |
Supports deferred automatic layout. |
void |
scrollRectToVisible |
Forwards the scrollRectToVisible() message to the JComponent's parent. |
final void |
setActionMap |
Sets the ActionMap to am. |
void |
setAlignmentX |
Sets the horizontal alignment. |
void |
setAlignmentY |
Sets the vertical alignment. |
void |
setAutoscrolls |
Sets the autoscrolls property. |
void |
setBackground |
Sets the background color of this component. |
void |
setBorder |
Sets the border of this component. |
void |
setComponentPopupMenu |
Sets the JPopupMenu for this JComponent. |
void |
setDebugGraphicsOptions |
Enables or disables diagnostic information about every graphics operation performed within the component or one of its children. |
static void |
setDefaultLocale |
Sets the default locale used to initialize each JComponent's locale property upon creation. |
void |
setDoubleBuffered |
Sets whether this component should use a buffer to paint. |
void |
setFocusTraversalKeys |
Sets the focus traversal keys for a given traversal operation for this Component. |
void |
setFont |
Sets the font for this component. |
void |
setForeground |
Sets the foreground color of this component. |
void |
setInheritsPopupMenu |
Sets whether or not getComponentPopupMenu should delegate to the parent if this component does not have a JPopupMenu assigned to it. |
final void |
setInputMap |
Sets the InputMap to use under the condition condition to map. |
void |
setInputVerifier |
Sets the input verifier for this component. |
void |
setMaximumSize |
Sets the maximum size of this component to a constant value. |
void |
setMinimumSize |
Sets the minimum size of this component to a constant value. |
void |
setNextFocusableComponent |
Deprecated. As of 1.4, replaced by FocusTraversalPolicy
|
void |
setOpaque |
If true the component paints every pixel within its bounds. |
void |
setPreferredSize |
Sets the preferred size of this component. |
void |
setRequestFocusEnabled |
Provides a hint as to whether or not this JComponent should get focus. |
void |
setToolTipText |
Registers the text to display in a tool tip. |
void |
setTransferHandler |
Sets the TransferHandler, which provides support for transfer of data into and out of this component via cut/copy/paste and drag and drop. |
protected void |
setUI |
Sets the look and feel delegate for this component. |
void |
setVerifyInputWhenFocusTarget |
Sets the value to indicate whether input verifier for the current focus owner will be called before this component requests focus. |
void |
setVisible |
Makes the component visible or invisible. |
void |
unregisterKeyboardAction |
This method is now obsolete. |
void |
update |
Calls paint. |
Methods declared in class Container
add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree | Modifier and Type | Method | Description |
|---|---|---|
Component |
add |
Appends the specified component to the end of this container. |
Component |
add |
Adds the specified component to this container at the given position. |
void |
add |
Adds the specified component to the end of this container. |
void |
add |
Adds the specified component to this container with the specified constraints at the specified index. |
Component |
add |
Adds the specified component to this container. |
void |
addContainerListener |
Adds the specified container listener to receive container events from this container. |
void |
addPropertyChangeListener |
Adds a PropertyChangeListener to the listener list. |
void |
addPropertyChangeListener |
Adds a PropertyChangeListener to the listener list for a specific property. |
void |
applyComponentOrientation |
Sets the ComponentOrientation property of this container and all components contained within it. |
boolean |
areFocusTraversalKeysSet |
Returns whether the Set of focus traversal keys for the given focus traversal operation has been explicitly defined for this Container. |
int |
countComponents() |
Deprecated. As of JDK version 1.1, replaced by getComponentCount(). |
void |
deliverEvent |
Deprecated. As of JDK version 1.1, replaced by dispatchEvent(AWTEvent e)
|
void |
doLayout() |
Causes this container to lay out its components. |
Component |
findComponentAt |
Locates the visible child component that contains the specified position. |
Component |
findComponentAt |
Locates the visible child component that contains the specified point. |
Component |
getComponent |
Gets the nth component in this container. |
Component |
getComponentAt |
Locates the component that contains the x,y position. |
Component |
getComponentAt |
Gets the component that contains the specified point. |
int |
getComponentCount() |
Gets the number of components in this panel. |
Component[] |
getComponents() |
Gets all the components in this container. |
int |
getComponentZOrder |
Returns the z-order index of the component inside the container. |
ContainerListener[] |
getContainerListeners() |
Returns an array of all the container listeners registered on this container. |
Set |
getFocusTraversalKeys |
Returns the Set of focus traversal keys for a given traversal operation for this Container. |
FocusTraversalPolicy |
getFocusTraversalPolicy() |
Returns the focus traversal policy that will manage keyboard traversal of this Container's children, or null if this Container is not a focus cycle root. |
LayoutManager |
getLayout() |
Gets the layout manager for this container. |
Point |
getMousePosition |
Returns the position of the mouse pointer in this Container's coordinate space if the Container is under the mouse pointer, otherwise returns null. |
Insets |
insets() |
Deprecated. As of JDK version 1.1, replaced by getInsets(). |
void |
invalidate() |
Invalidates the container. |
boolean |
isAncestorOf |
Checks if the component is contained in the component hierarchy of this container. |
boolean |
isFocusCycleRoot() |
Returns whether this Container is the root of a focus traversal cycle. |
boolean |
isFocusCycleRoot |
Returns whether the specified Container is the focus cycle root of this Container's focus traversal cycle. |
final boolean |
isFocusTraversalPolicyProvider() |
Returns whether this container provides focus traversal policy. |
boolean |
isFocusTraversalPolicySet() |
Returns whether the focus traversal policy has been explicitly set for this Container. |
void |
layout() |
Deprecated. As of JDK version 1.1, replaced by doLayout(). |
void |
list |
Prints a listing of this container to the specified output stream. |
void |
list |
Prints out a list, starting at the specified indentation, to the specified print writer. |
Component |
locate |
Deprecated. As of JDK version 1.1, replaced by getComponentAt(int, int). |
Dimension |
minimumSize() |
Deprecated. As of JDK version 1.1, replaced by getMinimumSize(). |
void |
paintComponents |
Paints each of the components in this container. |
Dimension |
preferredSize() |
Deprecated. As of JDK version 1.1, replaced by getPreferredSize(). |
void |
printComponents |
Prints each of the components in this container. |
protected void |
processContainerEvent |
Processes container events occurring on this container by dispatching them to any registered ContainerListener objects. |
protected void |
processEvent |
Processes events on this container. |
void |
removeContainerListener |
Removes the specified container listener so it no longer receives container events from this container. |
void |
setComponentZOrder |
Moves the specified component to the specified z-order index in the container. |
void |
setFocusCycleRoot |
Sets whether this Container is the root of a focus traversal cycle. |
void |
setFocusTraversalPolicy |
Sets the focus traversal policy that will manage keyboard traversal of this Container's children, if this Container is a focus cycle root. |
final void |
setFocusTraversalPolicyProvider |
Sets whether this container will be used to provide focus traversal policy. |
void |
setLayout |
Sets the layout manager for this container. |
void |
transferFocusDownCycle() |
Transfers the focus down one focus traversal cycle. |
void |
validate() |
Validates this container and all of its subcomponents. |
protected void |
validateTree() |
Recursively descends the container tree and recomputes the layout for any subtrees marked as needing it (those marked as invalid). |
Methods declared in class Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle | Modifier and Type | Method | Description |
|---|---|---|
boolean |
action |
Deprecated. As of JDK version 1.1, should register this component as ActionListener on component which fires action events. |
void |
add |
Adds the specified popup menu to the component. |
void |
addComponentListener |
Adds the specified component listener to receive component events from this component. |
void |
addFocusListener |
Adds the specified focus listener to receive focus events from this component when this component gains input focus. |
void |
addHierarchyBoundsListener |
Adds the specified hierarchy bounds listener to receive hierarchy bounds events from this component when the hierarchy to which this container belongs changes. |
void |
addHierarchyListener |
Adds the specified hierarchy listener to receive hierarchy changed events from this component when the hierarchy to which this container belongs changes. |
void |
addInputMethodListener |
Adds the specified input method listener to receive input method events from this component. |
void |
addKeyListener |
Adds the specified key listener to receive key events from this component. |
void |
addMouseListener |
Adds the specified mouse listener to receive mouse events from this component. |
void |
addMouseMotionListener |
Adds the specified mouse motion listener to receive mouse motion events from this component. |
void |
addMouseWheelListener |
Adds the specified mouse wheel listener to receive mouse wheel events from this component. |
Rectangle |
bounds() |
Deprecated. As of JDK version 1.1, replaced by getBounds(). |
int |
checkImage |
Returns the status of the construction of a screen representation of the specified image. |
int |
checkImage |
Returns the status of the construction of a screen representation of the specified image. |
protected AWTEvent |
coalesceEvents |
Potentially coalesce an event being posted with an existing event. |
boolean |
contains |
Checks whether this component "contains" the specified point, where the point's x and y coordinates are defined to be relative to the coordinate system of this component. |
Image |
createImage |
Creates an off-screen drawable image to be used for double buffering. |
Image |
createImage |
Creates an image from the specified image producer. |
VolatileImage |
createVolatileImage |
Creates a volatile off-screen drawable image to be used for double buffering. |
VolatileImage |
createVolatileImage |
Creates a volatile off-screen drawable image, with the given capabilities. |
protected final void |
disableEvents |
Disables the events defined by the specified event mask parameter from being delivered to this component. |
final void |
dispatchEvent |
Dispatches an event to this component or one of its sub components. |
void |
enable |
Deprecated. As of JDK version 1.1, replaced by setEnabled(boolean). |
protected final void |
enableEvents |
Enables the events defined by the specified event mask parameter to be delivered to this component. |
void |
enableInputMethods |
Enables or disables input method support for this component. |
void |
firePropertyChange |
Reports a bound property change. |
void |
firePropertyChange |
Reports a bound property change. |
void |
firePropertyChange |
Reports a bound property change. |
void |
firePropertyChange |
Reports a bound property change. |
void |
firePropertyChange |
Reports a bound property change. |
void |
firePropertyChange |
Reports a bound property change. |
protected void |
firePropertyChange |
Support for reporting bound property changes for Object properties. |
Color |
getBackground() |
Gets the background color of this component. |
Rectangle |
getBounds() |
Gets the bounds of this component in the form of a Rectangle object. |
ColorModel |
getColorModel() |
Gets the instance of ColorModel used to display the component on the output device. |
ComponentListener[] |
getComponentListeners() |
Returns an array of all the component listeners registered on this component. |
ComponentOrientation |
getComponentOrientation() |
Retrieves the language-sensitive orientation that is to be used to order the elements or text within this component. |
Cursor |
getCursor() |
Gets the cursor set in the component. |
DropTarget |
getDropTarget() |
Gets the DropTarget associated with this Component. |
Container |
getFocusCycleRootAncestor() |
Returns the Container which is the focus cycle root of this Component's focus traversal cycle. |
FocusListener[] |
getFocusListeners() |
Returns an array of all the focus listeners registered on this component. |
boolean |
getFocusTraversalKeysEnabled() |
Returns whether focus traversal keys are enabled for this Component. |
Font |
getFont() |
Gets the font of this component. |
Color |
getForeground() |
Gets the foreground color of this component. |
GraphicsConfiguration |
getGraphicsConfiguration() |
Gets the GraphicsConfiguration associated with this Component. |
HierarchyBoundsListener[] |
getHierarchyBoundsListeners() |
Returns an array of all the hierarchy bounds listeners registered on this component. |
HierarchyListener[] |
getHierarchyListeners() |
Returns an array of all the hierarchy listeners registered on this component. |
boolean |
getIgnoreRepaint() |
Returns whether or not paint messages received from the operating system should be ignored. |
InputContext |
getInputContext() |
Gets the input context used by this component for handling the communication with input methods when text is entered in this component. |
InputMethodListener[] |
getInputMethodListeners() |
Returns an array of all the input method listeners registered on this component. |
InputMethodRequests |
getInputMethodRequests() |
Gets the input method request handler which supports requests from input methods for this component. |
KeyListener[] |
getKeyListeners() |
Returns an array of all the key listeners registered on this component. |
Locale |
getLocale() |
Gets the locale of this component. |
Point |
getLocation() |
Gets the location of this component in the form of a point specifying the component's top-left corner. |
Point |
getLocationOnScreen() |
Gets the location of this component in the form of a point specifying the component's top-left corner in the screen's coordinate space. |
MouseListener[] |
getMouseListeners() |
Returns an array of all the mouse listeners registered on this component. |
MouseMotionListener[] |
getMouseMotionListeners() |
Returns an array of all the mouse motion listeners registered on this component. |
Point |
getMousePosition() |
Returns the position of the mouse pointer in this Component's coordinate space if the Component is directly under the mouse pointer, otherwise returns null. |
MouseWheelListener[] |
getMouseWheelListeners() |
Returns an array of all the mouse wheel listeners registered on this component. |
String |
getName() |
Gets the name of the component. |
Container |
getParent() |
Gets the parent of this component. |
PropertyChangeListener[] |
getPropertyChangeListeners() |
Returns an array of all the property change listeners registered on this component. |
PropertyChangeListener[] |
getPropertyChangeListeners |
Returns an array of all the listeners which have been associated with the named property. |
Dimension |
getSize() |
Returns the size of this component in the form of a Dimension object. |
Toolkit |
getToolkit() |
Gets the toolkit of this component. |
final Object |
getTreeLock() |
Gets this component's locking object (the object that owns the thread synchronization monitor) for AWT component-tree and layout operations. |
boolean |
gotFocus |
Deprecated. As of JDK version 1.1, replaced by processFocusEvent(FocusEvent). |
boolean |
handleEvent |
Deprecated. As of JDK version 1.1 replaced by processEvent(AWTEvent). |
boolean |
hasFocus() |
Returns true if this Component is the focus owner. |
boolean |
imageUpdate |
Repaints the component when the image has changed. |
boolean |
inside |
Deprecated. As of JDK version 1.1, replaced by contains(int, int). |
boolean |
isBackgroundSet() |
Returns whether the background color has been explicitly set for this Component. |
boolean |
isCursorSet() |
Returns whether the cursor has been explicitly set for this Component. |
boolean |
isDisplayable() |
Determines whether this component is displayable. |
boolean |
isEnabled() |
Determines whether this component is enabled. |
boolean |
isFocusable() |
Returns whether this Component can be focused. |
boolean |
isFocusOwner() |
Returns true if this Component is the focus owner. |
boolean |
isFocusTraversable() |
Deprecated. As of 1.4, replaced by isFocusable(). |
boolean |
isFontSet() |
Returns whether the font has been explicitly set for this Component. |
boolean |
isForegroundSet() |
Returns whether the foreground color has been explicitly set for this Component. |
boolean |
isLightweight() |
A lightweight component doesn't have a native toolkit peer. |
boolean |
isMaximumSizeSet() |
Returns true if the maximum size has been set to a non- null value otherwise returns false. |
boolean |
isMinimumSizeSet() |
Returns whether or not setMinimumSize has been invoked with a non-null value. |
boolean |
isPreferredSizeSet() |
Returns true if the preferred size has been set to a non- null value otherwise returns false. |
boolean |
isShowing() |
Determines whether this component is showing on screen. |
boolean |
isValid() |
Determines whether this component is valid. |
boolean |
isVisible() |
Determines whether this component should be visible when its parent is visible. |
boolean |
keyDown |
Deprecated. As of JDK version 1.1, replaced by processKeyEvent(KeyEvent). |
boolean |
keyUp |
Deprecated. As of JDK version 1.1, replaced by processKeyEvent(KeyEvent). |
void |
list() |
Prints a listing of this component to the standard system output stream System.out. |
void |
list |
Prints a listing of this component to the specified output stream. |
void |
list |
Prints a listing to the specified print writer. |
Point |
location() |
Deprecated. As of JDK version 1.1, replaced by getLocation(). |
boolean |
lostFocus |
Deprecated. As of JDK version 1.1, replaced by processFocusEvent(FocusEvent). |
boolean |
mouseDown |
Deprecated. As of JDK version 1.1, replaced by processMouseEvent(MouseEvent). |
boolean |
mouseDrag |
Deprecated. As of JDK version 1.1, replaced by processMouseMotionEvent(MouseEvent). |
boolean |
mouseEnter |
Deprecated. As of JDK version 1.1, replaced by processMouseEvent(MouseEvent). |
boolean |
mouseExit |
Deprecated. As of JDK version 1.1, replaced by processMouseEvent(MouseEvent). |
boolean |
mouseMove |
Deprecated. As of JDK version 1.1, replaced by processMouseMotionEvent(MouseEvent). |
boolean |
mouseUp |
Deprecated. As of JDK version 1.1, replaced by processMouseEvent(MouseEvent). |
void |
move |
Deprecated. As of JDK version 1.1, replaced by setLocation(int, int). |
void |
nextFocus() |
Deprecated. As of JDK version 1.1, replaced by transferFocus(). |
void |
paintAll |
Paints this component and all of its subcomponents. |
boolean |
postEvent |
Deprecated. As of JDK version 1.1, replaced by dispatchEvent(AWTEvent). |
boolean |
prepareImage |
Prepares an image for rendering on this component at the specified width and height. |
boolean |
prepareImage |
Prepares an image for rendering on this component. |
protected void |
processComponentEvent |
Processes component events occurring on this component by dispatching them to any registered ComponentListener objects. |
protected void |
processFocusEvent |
Processes focus events occurring on this component by dispatching them to any registered FocusListener objects. |
protected void |
processHierarchyBoundsEvent |
Processes hierarchy bounds events occurring on this component by dispatching them to any registered HierarchyBoundsListener objects. |
protected void |
processHierarchyEvent |
Processes hierarchy events occurring on this component by dispatching them to any registered HierarchyListener objects. |
protected void |
processInputMethodEvent |
Processes input method events occurring on this component by dispatching them to any registered InputMethodListener objects. |
protected void |
processMouseWheelEvent |
Processes mouse wheel events occurring on this component by dispatching them to any registered MouseWheelListener objects. |
void |
remove |
Removes the specified popup menu from the component. |
void |
removeComponentListener |
Removes the specified component listener so that it no longer receives component events from this component. |
void |
removeFocusListener |
Removes the specified focus listener so that it no longer receives focus events from this component. |
void |
removeHierarchyBoundsListener |
Removes the specified hierarchy bounds listener so that it no longer receives hierarchy bounds events from this component. |
void |
removeHierarchyListener |
Removes the specified hierarchy listener so that it no longer receives hierarchy changed events from this component. |
void |
removeInputMethodListener |
Removes the specified input method listener so that it no longer receives input method events from this component. |
void |
removeKeyListener |
Removes the specified key listener so that it no longer receives key events from this component. |
void |
removeMouseListener |
Removes the specified mouse listener so that it no longer receives mouse events from this component. |
void |
removeMouseMotionListener |
Removes the specified mouse motion listener so that it no longer receives mouse motion events from this component. |
void |
removeMouseWheelListener |
Removes the specified mouse wheel listener so that it no longer receives mouse wheel events from this component. |
void |
removePropertyChangeListener |
Removes a PropertyChangeListener from the listener list. |
void |
removePropertyChangeListener |
Removes a PropertyChangeListener from the listener list for a specific property. |
void |
repaint() |
Repaints this component. |
void |
repaint |
Repaints the specified rectangle of this component. |
void |
repaint |
Repaints the component. |
protected boolean |
requestFocus |
Requests by the reason of cause that this Component get the input focus, and that this Component's top-level ancestor become the focused Window. |
void |
requestFocus |
Requests by the reason of cause that this Component get the input focus, and that this Component's top-level ancestor become the focused Window. |
boolean |
requestFocusInWindow |
Requests by the reason of cause that this Component get the input focus, if this Component's top-level ancestor is already the focused Window. |
void |
resize |
Deprecated. As of JDK version 1.1, replaced by setSize(int, int). |
void |
resize |
Deprecated. As of JDK version 1.1, replaced by setSize(Dimension). |
void |
setBounds |
Moves and resizes this component. |
void |
setBounds |
Moves and resizes this component to conform to the new bounding rectangle r. |
void |
setCursor |
Sets the cursor image to the specified cursor. |
void |
setDropTarget |
Associate a DropTarget with this component. |
void |
setFocusable |
Sets the focusable state of this Component to the specified value. |
void |
setFocusTraversalKeysEnabled |
Sets whether focus traversal keys are enabled for this Component. |
void |
setIgnoreRepaint |
Sets whether or not paint messages received from the operating system should be ignored. |
void |
setLocale |
Sets the locale of this component. |
void |
setLocation |
Moves this component to a new location. |
void |
setLocation |
Moves this component to a new location. |
void |
setMixingCutoutShape |
Sets a 'mixing-cutout' shape for this lightweight component. |
void |
setName |
Sets the name of the component to the specified string. |
void |
setSize |
Resizes this component so that it has width width and height height. |
void |
setSize |
Resizes this component so that it has width d.width and height d.height. |
void |
show() |
Deprecated. As of JDK version 1.1, replaced by setVisible(boolean). |
void |
show |
Deprecated. As of JDK version 1.1, replaced by setVisible(boolean). |
Dimension |
size() |
Deprecated. As of JDK version 1.1, replaced by getSize(). |
String |
toString() |
Returns a string representation of this component and its values. |
void |
transferFocus() |
Transfers the focus to the next component, as though this Component were the focus owner. |
void |
transferFocusBackward() |
Transfers the focus to the previous component, as though this Component were the focus owner. |
void |
transferFocusUpCycle() |
Transfers the focus up one focus traversal cycle. |
Methods declared in class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait | Modifier and Type | Method | Description |
|---|---|---|
protected Object |
clone() |
Creates and returns a copy of this object. |
boolean |
equals |
Indicates whether some other object is "equal to" this one. |
protected void |
finalize() |
Deprecated, for removal: This API element is subject to removal in a future version. Finalization is deprecated and subject to removal in a future release. |
final Class |
getClass() |
Returns the runtime class of this Object. |
int |
hashCode() |
Returns a hash code value for this object. |
final void |
notify() |
Wakes up a single thread that is waiting on this object's monitor. |
final void |
notifyAll() |
Wakes up all threads that are waiting on this object's monitor. |
final void |
wait() |
Causes the current thread to wait until it is awakened, typically by being notified or interrupted. |
final void |
wait |
Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. |
final void |
wait |
Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. |
Field Details
VERTICAL_SPLIT
public static final int VERTICAL_SPLIT
Components are split along the y axis. For example the two Components will be split one on top of the other.- See Also:
HORIZONTAL_SPLIT
public static final int HORIZONTAL_SPLIT
Components are split along the x axis. For example the two Components will be split one to the left of the other.- See Also:
LEFT
public static final String LEFT
Component to the left of the other Component.- See Also:
RIGHT
public static final String RIGHT
Component to the right of the other Component.- See Also:
TOP
public static final String TOP
Component above the other Component.- See Also:
BOTTOM
public static final String BOTTOM
Component below the other Component.- See Also:
DIVIDER
public static final String DIVIDER
Component that will represent the divider.- See Also:
ORIENTATION_PROPERTY
public static final String ORIENTATION_PROPERTY
- See Also:
CONTINUOUS_LAYOUT_PROPERTY
public static final String CONTINUOUS_LAYOUT_PROPERTY
- See Also:
DIVIDER_SIZE_PROPERTY
public static final String DIVIDER_SIZE_PROPERTY
- See Also:
ONE_TOUCH_EXPANDABLE_PROPERTY
public static final String ONE_TOUCH_EXPANDABLE_PROPERTY
- See Also:
LAST_DIVIDER_LOCATION_PROPERTY
public static final String LAST_DIVIDER_LOCATION_PROPERTY
- See Also:
DIVIDER_LOCATION_PROPERTY
public static final String DIVIDER_LOCATION_PROPERTY
- Since:
- 1.3
- See Also:
RESIZE_WEIGHT_PROPERTY
public static final String RESIZE_WEIGHT_PROPERTY
- Since:
- 1.3
- See Also:
orientation
protected int orientation
continuousLayout
protected boolean continuousLayout
leftComponent
protected Component leftComponent
rightComponent
protected Component rightComponent
dividerSize
protected int dividerSize
oneTouchExpandable
protected boolean oneTouchExpandable
lastDividerLocation
protected int lastDividerLocation
Constructor Details
JSplitPane
public JSplitPane()
JSplitPane configured to arrange the child components side-by-side horizontally, using two buttons for the components.JSplitPane
@ConstructorProperties("orientation") public JSplitPane(int newOrientation) JSplitPane configured with the specified orientation.- Parameters:
-
newOrientation-JSplitPane.HORIZONTAL_SPLITorJSplitPane.VERTICAL_SPLIT - Throws:
-
IllegalArgumentException- iforientationis not one of HORIZONTAL_SPLIT or VERTICAL_SPLIT.
JSplitPane
public JSplitPane(int newOrientation, boolean newContinuousLayout)
JSplitPane with the specified orientation and redrawing style.- Parameters:
-
newOrientation-JSplitPane.HORIZONTAL_SPLITorJSplitPane.VERTICAL_SPLIT -
newContinuousLayout- a boolean, true for the components to redraw continuously as the divider changes position, false to wait until the divider position stops changing to redraw - Throws:
-
IllegalArgumentException- iforientationis not one of HORIZONTAL_SPLIT or VERTICAL_SPLIT
JSplitPane
public JSplitPane(int newOrientation, Component newLeftComponent, Component newRightComponent)
JSplitPane with the specified orientation and the specified components.- Parameters:
-
newOrientation-JSplitPane.HORIZONTAL_SPLITorJSplitPane.VERTICAL_SPLIT -
newLeftComponent- theComponentthat will appear on the left of a horizontally-split pane, or at the top of a vertically-split pane -
newRightComponent- theComponentthat will appear on the right of a horizontally-split pane, or at the bottom of a vertically-split pane - Throws:
-
IllegalArgumentException- iforientationis not one of: HORIZONTAL_SPLIT or VERTICAL_SPLIT
JSplitPane
public JSplitPane(int newOrientation, boolean newContinuousLayout, Component newLeftComponent, Component newRightComponent)
JSplitPane with the specified orientation and redrawing style, and with the specified components.- Parameters:
-
newOrientation-JSplitPane.HORIZONTAL_SPLITorJSplitPane.VERTICAL_SPLIT -
newContinuousLayout- a boolean, true for the components to redraw continuously as the divider changes position, false to wait until the divider position stops changing to redraw -
newLeftComponent- theComponentthat will appear on the left of a horizontally-split pane, or at the top of a vertically-split pane -
newRightComponent- theComponentthat will appear on the right of a horizontally-split pane, or at the bottom of a vertically-split pane - Throws:
-
IllegalArgumentException- iforientationis not one of HORIZONTAL_SPLIT or VERTICAL_SPLIT
Method Details
setComponentOrientation
public void setComponentOrientation(ComponentOrientation orientation)
LayoutManager and Component subclasses will use this property to determine how to lay out and draw components. At construction time, a component's orientation is set to ComponentOrientation.UNKNOWN, indicating that it has not been specified explicitly. The UNKNOWN orientation behaves the same as ComponentOrientation.LEFT_TO_RIGHT.
To set the orientation of a single component, use this method. To set the orientation of an entire component hierarchy, use applyComponentOrientation.
This method changes layout-related information, and therefore, invalidates the component hierarchy.
- Overrides:
-
setComponentOrientationin classComponent - Parameters:
-
orientation- the orientation to be set - See Also:
setEnabled
public void setEnabled(boolean enabled)
Note: Disabling a component does not disable its children.
Note: Disabling a lightweight component does not prevent it from receiving MouseEvents.
- Overrides:
-
setEnabledin classJComponent - Parameters:
-
enabled- true if this component should be enabled, false otherwise - See Also:
setUI
public void setUI(SplitPaneUI ui)
- Parameters:
-
ui- theSplitPaneUIL&F object - See Also:
getUI
@BeanProperty(bound=false, expert=true, description="The L&F object that renders this component.") public SplitPaneUI getUI()
SplitPaneUI that is providing the current look and feel.- Overrides:
-
getUIin classJComponent - Returns:
- the
SplitPaneUIobject that renders this component
updateUI
public void updateUI()
UIManager that the L&F has changed. Replaces the current UI object with the latest version from the UIManager.- Overrides:
-
updateUIin classJComponent - See Also:
getUIClassID
@BeanProperty(bound=false, expert=true, description="A string that specifies the name of the L&F class.") public String getUIClassID()
- Overrides:
-
getUIClassIDin classJComponent - Returns:
- the string "SplitPaneUI"
- See Also:
setDividerSize
@BeanProperty(description="The size of the divider.") public void setDividerSize(int newSize)
newSize < 0 are ignored.- Parameters:
-
newSize- an integer giving the size of the divider in pixels
getDividerSize
public int getDividerSize()
- Returns:
- an integer giving the size of the divider in pixels
setLeftComponent
public void setLeftComponent(Component comp)
- Parameters:
-
comp- theComponentto display in that position
getLeftComponent
@BeanProperty(bound=false, preferred=true, description="The component to the left (or above) the divider.") public Component getLeftComponent()
- Returns:
- the
Componentdisplayed in that position
setTopComponent
@BeanProperty(bound=false, description="The component above, or to the left of the divider.") public void setTopComponent(Component comp)
- Parameters:
-
comp- theComponentto display in that position
getTopComponent
public Component getTopComponent()
- Returns:
- the
Componentdisplayed in that position
setRightComponent
@BeanProperty(bound=false, preferred=true, description="The component to the right (or below) the divider.") public void setRightComponent(Component comp)
- Parameters:
-
comp- theComponentto display in that position
getRightComponent
public Component getRightComponent()
- Returns:
- the
Componentdisplayed in that position
setBottomComponent
@BeanProperty(bound=false, description="The component below, or to the right of the divider.") public void setBottomComponent(Component comp)
- Parameters:
-
comp- theComponentto display in that position
getBottomComponent
public Component getBottomComponent()
- Returns:
- the
Componentdisplayed in that position
setOneTouchExpandable
@BeanProperty(description="UI widget on the divider to quickly expand/collapse the divider.") public void setOneTouchExpandable(boolean newValue)
oneTouchExpandable property, which must be true for the JSplitPane to provide a UI widget on the divider to quickly expand/collapse the divider. The default value of this property is false. Some look and feels might not support one-touch expanding; they will ignore this property.- Parameters:
-
newValue-trueto specify that the split pane should provide a collapse/expand widget - See Also:
isOneTouchExpandable
public boolean isOneTouchExpandable()
oneTouchExpandable property.- Returns:
- the value of the
oneTouchExpandableproperty - See Also:
setLastDividerLocation
@BeanProperty(description="The last location the divider was at.") public void setLastDividerLocation(int newLastLocation)
newLastLocation.- Parameters:
-
newLastLocation- an integer specifying the last divider location in pixels, from the left (or upper) edge of the pane to the left (or upper) edge of the divider
getLastDividerLocation
public int getLastDividerLocation()
- Returns:
- an integer specifying the last divider location as a count of pixels from the left (or upper) edge of the pane to the left (or upper) edge of the divider
setOrientation
@BeanProperty(enumerationValues={"JSplitPane.HORIZONTAL_SPLIT","JSplitPane.VERTICAL_SPLIT"}, description="The orientation, or how the splitter is divided.") public void setOrientation(int orientation) - JSplitPane.VERTICAL_SPLIT (above/below orientation of components)
- JSplitPane.HORIZONTAL_SPLIT (left/right orientation of components)
- Parameters:
-
orientation- an integer specifying the orientation - Throws:
-
IllegalArgumentException- if orientation is not one of: HORIZONTAL_SPLIT or VERTICAL_SPLIT.
getOrientation
public int getOrientation()
- Returns:
- an integer giving the orientation
- See Also:
setContinuousLayout
@BeanProperty(description="Whether the child components are continuously redisplayed and laid out during user intervention.") public void setContinuousLayout(boolean newContinuousLayout)
continuousLayout property, which must be true for the child components to be continuously redisplayed and laid out during user intervention. The default value of this property is look and feel dependent. Some look and feels might not support continuous layout; they will ignore this property.- Parameters:
-
newContinuousLayout-trueif the components should continuously be redrawn as the divider changes position - See Also:
isContinuousLayout
public boolean isContinuousLayout()
continuousLayout property.- Returns:
- the value of the
continuousLayoutproperty - See Also:
setResizeWeight
@BeanProperty(description="Specifies how to distribute extra space when the split pane resizes.") public void setResizeWeight(double value)
- Parameters:
-
value- as described above - Throws:
-
IllegalArgumentException- ifvalueis < 0 or > 1 - Since:
- 1.3
getResizeWeight
public double getResizeWeight()
- Returns:
- how extra space is to be distributed on a resize of the split pane
- Since:
- 1.3
resetToPreferredSizes
public void resetToPreferredSizes()
JSplitPane layout based on the preferred size of the children components. This will likely result in changing the divider location.setDividerLocation
@BeanProperty(description="The location of the divider.") public void setDividerLocation(double proportionalLocation)
JSplitPane's size. This method is implemented in terms of setDividerLocation(int). This method immediately changes the size of the split pane based on its current size. If the split pane is not correctly realized and on screen, this method will have no effect (new divider location will become (current size * proportionalLocation) which is 0).
- Parameters:
-
proportionalLocation- a double-precision floating point value that specifies a percentage, from zero (top/left) to 1.0 (bottom/right) - Throws:
-
IllegalArgumentException- if the specified location is < 0 or > 1.0
setDividerLocation
@BeanProperty(description="The location of the divider.") public void setDividerLocation(int location)
setLastDividerLocation.- Parameters:
-
location- an int specifying a UI-specific value (typically a pixel count)
getDividerLocation
public int getDividerLocation()
setDividerLocation. The value returned from this method may differ from the actual divider location (if setDividerLocation was passed a value bigger than the current size).- Returns:
- an integer specifying the location of the divider
getMinimumDividerLocation
@BeanProperty(bound=false, description="The minimum location of the divider from the L&F.") public int getMinimumDividerLocation()
- Returns:
- an integer specifying a UI-specific value for the minimum location (typically a pixel count); or -1 if the UI is
null
getMaximumDividerLocation
@BeanProperty(bound=false) public int getMaximumDividerLocation()
- Returns:
- an integer specifying a UI-specific value for the maximum location (typically a pixel count); or -1 if the UI is
null
remove
remove
public void remove(int index)
Component at the specified index. Updates the leftComponent and rightComponent instance variables as necessary, and then messages super.removeAll
isValidateRoot
@BeanProperty(hidden=true) public boolean isValidateRoot()
revalidate on any descendant of this JSplitPane will cause a request to be queued that will validate the JSplitPane and all its descendants.- Overrides:
-
isValidateRootin classJComponent - Returns:
- true
- See Also:
addImpl
protected void addImpl(Component comp, Object constraints, int index)
constraints identifies the left/top or right/bottom child component, and a component with that identifier was previously added, it will be removed and then comp will be added in its place. If constraints is not one of the known identifiers the layout manager may throw an IllegalArgumentException. The possible constraints objects (Strings) are:
- JSplitPane.TOP
- JSplitPane.LEFT
- JSplitPane.BOTTOM
- JSplitPane.RIGHT
constraints object is null, the component is added in the first available position (left/top if open, else right/bottom).- Overrides:
-
addImplin classContainer - Parameters:
-
comp- the component to add -
constraints- anObjectspecifying the layout constraints (position) for this component -
index- an integer specifying the index in the container's list. - Throws:
-
IllegalArgumentException- if theconstraintsobject does not match an existing component - See Also:
paintChildren
protected void paintChildren(Graphics g)
finishedPaintingChildren after super has been messaged, as well as painting the border.- Overrides:
-
paintChildrenin classJComponent - Parameters:
-
g- theGraphicscontext within which to paint - See Also:
paramString
protected String paramString()
JSplitPane. This method is intended to be used only for debugging purposes, and the content and format of the returned string may vary between implementations. The returned string may be empty but may not be null.- Overrides:
-
paramStringin classJComponent - Returns:
- a string representation of this
JSplitPane.
getAccessibleContext
@BeanProperty(bound=false, expert=true, description="The AccessibleContext associated with this SplitPane.") public AccessibleContext getAccessibleContext()
- Specified by:
-
getAccessibleContextin interfaceAccessible - Overrides:
-
getAccessibleContextin classComponent - Returns:
- an AccessibleJSplitPane that serves as the AccessibleContext of this JSplitPane
© 1993, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
java.awt.Component.setEnabled(boolean).