Spec-Zone.ru › OpenJDK 27

Class JSplitPane

java.lang.Object
java.awt.Component
java.awt.Container
javax.swing.JComponent
javax.swing.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:
  • setDividerLocation(double)
  • resetToPreferredSizes()

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(int newOrientation)
Creates a new JSplitPane configured with the specified orientation.
JSplitPane(int newOrientation, boolean newContinuousLayout)
Creates a new JSplitPane with the specified orientation and redrawing style.
JSplitPane(int newOrientation, boolean newContinuousLayout, Component newLeftComponent, Component newRightComponent)
Creates a new JSplitPane with the specified orientation and redrawing style, and with the specified components.
JSplitPane(int newOrientation, Component newLeftComponent, Component newRightComponent)
Creates a new JSplitPane with the specified orientation and the specified components.

Method Summary

Modifier and Type Method Description
protected void addImpl(Component comp, Object constraints, int index)
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(Graphics g)
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(int index)
Removes the Component at the specified index.
void remove(Component component)
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(Component comp)
Sets the component below, or to the right of the divider.
void setComponentOrientation(ComponentOrientation orientation)
Sets the language-sensitive orientation that is to be used to order the elements or text within this component.
void setContinuousLayout(boolean newContinuousLayout)
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(double proportionalLocation)
Sets the divider location as a percentage of the JSplitPane's size.
void setDividerLocation(int location)
Sets the location of the divider.
void setDividerSize(int newSize)
Sets the size of the divider.
void setEnabled(boolean enabled)
Sets whether or not this component is enabled.
void setLastDividerLocation(int newLastLocation)
Sets the last location the divider was at to newLastLocation.
void setLeftComponent(Component comp)
Sets the component to the left (or above) the divider.
void setOneTouchExpandable(boolean newValue)
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(int orientation)
Sets the orientation, or how the splitter is divided.
void setResizeWeight(double value)
Specifies how to distribute extra space when the size of the split pane changes.
void setRightComponent(Component comp)
Sets the component to the right (or below) the divider.
void setTopComponent(Component comp)
Sets the component above, or to the left of the divider.
void setUI(SplitPaneUI ui)
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(AncestorListener listener)
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(VetoableChangeListener listener)
Adds a VetoableChangeListener to the listener list.
void computeVisibleRect(Rectangle visibleRect)
Returns the Component's "visible rect rectangle" - the intersection of the visible rectangles for this component and all of its ancestors.
boolean contains(int x, int y)
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.
As of JDK version 1.1, replaced by java.awt.Component.setEnabled(boolean).
void enable()
Deprecated.
As of JDK version 1.1, replaced by java.awt.Component.setEnabled(boolean).
void firePropertyChange(String propertyName, boolean oldValue, boolean newValue)
Support for reporting bound property changes for boolean properties.
void firePropertyChange(String propertyName, int oldValue, int newValue)
Support for reporting bound property changes for integer properties.
protected void fireVetoableChange(String propertyName, Object oldValue, Object newValue)
Supports reporting constrained property changes.
ActionListener getActionForKeyStroke(KeyStroke aKeyStroke)
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(int width, int height)
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(Rectangle rv)
Stores the bounds of this component into "return value" rv and returns rv.
final Object getClientProperty(Object key)
Returns the value of the property with the specified key.
protected Graphics getComponentGraphics(Graphics g)
Returns the graphics object used to paint this component.
JPopupMenu getComponentPopupMenu()
Returns JPopupMenu that assigned for this component.
int getConditionForKeyStroke(KeyStroke aKeyStroke)
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(Font font)
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(int condition)
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(Insets insets)
Returns an Insets object containing this component's inset values.
<T extends EventListener>
T[]
getListeners(Class<T> listenerType)
Returns an array of all the objects currently registered as FooListeners upon this JComponent.
Point getLocation(Point rv)
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(MouseEvent event)
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(Dimension rv)
Stores the width/height of this component into "return value" rv and returns rv.
Point getToolTipLocation(MouseEvent event)
Returns the tooltip location in this component's coordinate system.
String getToolTipText()
Returns the tooltip string that has been set with setToolTipText.
String getToolTipText(MouseEvent event)
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(Component c)
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(Graphics g)
Invoked by Swing to draw components.
protected void paintBorder(Graphics g)
Paints the component's border.
protected void paintComponent(Graphics g)
Calls the UI delegate's paint method, if the UI delegate is non-null.
void paintImmediately(int x, int y, int w, int h)
Paints the specified region in this component and all of its descendants that overlap the region, immediately.
void paintImmediately(Rectangle r)
Paints the specified region now.
void print(Graphics g)
Invoke this method to print the component to the specified Graphics.
void printAll(Graphics g)
Invoke this method to print the component.
protected void printBorder(Graphics g)
Prints the component's border.
protected void printChildren(Graphics g)
Prints this component's children.
protected void printComponent(Graphics g)
This is invoked during a printing operation.
protected void processComponentKeyEvent(KeyEvent e)
Processes any key events that the component itself recognizes.
protected boolean processKeyBinding(KeyStroke ks, KeyEvent e, int condition, boolean pressed)
Invoked to process the key bindings for ks as the result of the KeyEvent e.
protected void processKeyEvent(KeyEvent e)
Overrides processKeyEvent to process events.
protected void processMouseEvent(MouseEvent e)
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(MouseEvent e)
Processes mouse motion events, such as MouseEvent.MOUSE_DRAGGED.
final void putClientProperty(Object key, Object value)
Adds an arbitrary key/value "client property" to this component.
void registerKeyboardAction(ActionListener anAction, String aCommand, KeyStroke aKeyStroke, int aCondition)
This method is now obsolete, please use a combination of getActionMap() and getInputMap() for similar behavior.
void registerKeyboardAction(ActionListener anAction, KeyStroke aKeyStroke, int aCondition)
This method is now obsolete, please use a combination of getActionMap() and getInputMap() for similar behavior.
void removeAncestorListener(AncestorListener listener)
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(VetoableChangeListener listener)
Removes a VetoableChangeListener from the listener list.
void repaint(long tm, int x, int y, int width, int height)
Adds the specified region to the dirty region list if the component is showing.
void repaint(Rectangle r)
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(boolean temporary)
Requests that this Component gets the input focus.
boolean requestFocusInWindow()
Requests that this Component gets the input focus.
protected boolean requestFocusInWindow(boolean temporary)
Requests that this Component gets the input focus.
void resetKeyboardActions()
Unregisters all the bindings in the first tier InputMaps and ActionMap.
void reshape(int x, int y, int w, int h)
Deprecated.
As of JDK 5, replaced by Component.setBounds(int, int, int, int).
void revalidate()
Supports deferred automatic layout.
void scrollRectToVisible(Rectangle aRect)
Forwards the scrollRectToVisible() message to the JComponent's parent.
final void setActionMap(ActionMap am)
Sets the ActionMap to am.
void setAlignmentX(float alignmentX)
Sets the horizontal alignment.
void setAlignmentY(float alignmentY)
Sets the vertical alignment.
void setAutoscrolls(boolean autoscrolls)
Sets the autoscrolls property.
void setBackground(Color bg)
Sets the background color of this component.
void setBorder(Border border)
Sets the border of this component.
void setComponentPopupMenu(JPopupMenu popup)
Sets the JPopupMenu for this JComponent.
void setDebugGraphicsOptions(int debugOptions)
Enables or disables diagnostic information about every graphics operation performed within the component or one of its children.
static void setDefaultLocale(Locale l)
Sets the default locale used to initialize each JComponent's locale property upon creation.
void setDoubleBuffered(boolean aFlag)
Sets whether this component should use a buffer to paint.
void setFocusTraversalKeys(int id, Set<? extends AWTKeyStroke> keystrokes)
Sets the focus traversal keys for a given traversal operation for this Component.
void setFont(Font font)
Sets the font for this component.
void setForeground(Color fg)
Sets the foreground color of this component.
void setInheritsPopupMenu(boolean value)
Sets whether or not getComponentPopupMenu should delegate to the parent if this component does not have a JPopupMenu assigned to it.
final void setInputMap(int condition, InputMap map)
Sets the InputMap to use under the condition condition to map.
void setInputVerifier(InputVerifier inputVerifier)
Sets the input verifier for this component.
void setMaximumSize(Dimension maximumSize)
Sets the maximum size of this component to a constant value.
void setMinimumSize(Dimension minimumSize)
Sets the minimum size of this component to a constant value.
void setNextFocusableComponent(Component aComponent)
Deprecated.
As of 1.4, replaced by FocusTraversalPolicy
void setOpaque(boolean isOpaque)
If true the component paints every pixel within its bounds.
void setPreferredSize(Dimension preferredSize)
Sets the preferred size of this component.
void setRequestFocusEnabled(boolean requestFocusEnabled)
Provides a hint as to whether or not this JComponent should get focus.
void setToolTipText(String text)
Registers the text to display in a tool tip.
void setTransferHandler(TransferHandler newHandler)
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(ComponentUI newUI)
Sets the look and feel delegate for this component.
void setVerifyInputWhenFocusTarget(boolean verifyInputWhenFocusTarget)
Sets the value to indicate whether input verifier for the current focus owner will be called before this component requests focus.
void setVisible(boolean aFlag)
Makes the component visible or invisible.
void unregisterKeyboardAction(KeyStroke aKeyStroke)
This method is now obsolete.
void update(Graphics g)
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(Component comp)
Appends the specified component to the end of this container.
Component add(Component comp, int index)
Adds the specified component to this container at the given position.
void add(Component comp, Object constraints)
Adds the specified component to the end of this container.
void add(Component comp, Object constraints, int index)
Adds the specified component to this container with the specified constraints at the specified index.
Component add(String name, Component comp)
Adds the specified component to this container.
void addContainerListener(ContainerListener l)
Adds the specified container listener to receive container events from this container.
void addPropertyChangeListener(PropertyChangeListener listener)
Adds a PropertyChangeListener to the listener list.
void addPropertyChangeListener(String propertyName, PropertyChangeListener listener)
Adds a PropertyChangeListener to the listener list for a specific property.
void applyComponentOrientation(ComponentOrientation o)
Sets the ComponentOrientation property of this container and all components contained within it.
boolean areFocusTraversalKeysSet(int id)
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(Event e)
Deprecated.
As of JDK version 1.1, replaced by dispatchEvent(AWTEvent e)
void doLayout()
Causes this container to lay out its components.
Component findComponentAt(int x, int y)
Locates the visible child component that contains the specified position.
Component findComponentAt(Point p)
Locates the visible child component that contains the specified point.
Component getComponent(int n)
Gets the nth component in this container.
Component getComponentAt(int x, int y)
Locates the component that contains the x,y position.
Component getComponentAt(Point p)
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(Component comp)
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<AWTKeyStroke> getFocusTraversalKeys(int id)
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(boolean allowChildren)
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(Component c)
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(Container container)
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(PrintStream out, int indent)
Prints a listing of this container to the specified output stream.
void list(PrintWriter out, int indent)
Prints out a list, starting at the specified indentation, to the specified print writer.
Component locate(int x, int y)
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(Graphics g)
Paints each of the components in this container.
Dimension preferredSize()
Deprecated.
As of JDK version 1.1, replaced by getPreferredSize().
void printComponents(Graphics g)
Prints each of the components in this container.
protected void processContainerEvent(ContainerEvent e)
Processes container events occurring on this container by dispatching them to any registered ContainerListener objects.
protected void processEvent(AWTEvent e)
Processes events on this container.
void removeContainerListener(ContainerListener l)
Removes the specified container listener so it no longer receives container events from this container.
void setComponentZOrder(Component comp, int index)
Moves the specified component to the specified z-order index in the container.
void setFocusCycleRoot(boolean focusCycleRoot)
Sets whether this Container is the root of a focus traversal cycle.
void setFocusTraversalPolicy(FocusTraversalPolicy policy)
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(boolean provider)
Sets whether this container will be used to provide focus traversal policy.
void setLayout(LayoutManager mgr)
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(Event evt, Object what)
Deprecated.
As of JDK version 1.1, should register this component as ActionListener on component which fires action events.
void add(PopupMenu popup)
Adds the specified popup menu to the component.
void addComponentListener(ComponentListener l)
Adds the specified component listener to receive component events from this component.
void addFocusListener(FocusListener l)
Adds the specified focus listener to receive focus events from this component when this component gains input focus.
void addHierarchyBoundsListener(HierarchyBoundsListener l)
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(HierarchyListener l)
Adds the specified hierarchy listener to receive hierarchy changed events from this component when the hierarchy to which this container belongs changes.
void addInputMethodListener(InputMethodListener l)
Adds the specified input method listener to receive input method events from this component.
void addKeyListener(KeyListener l)
Adds the specified key listener to receive key events from this component.
void addMouseListener(MouseListener l)
Adds the specified mouse listener to receive mouse events from this component.
void addMouseMotionListener(MouseMotionListener l)
Adds the specified mouse motion listener to receive mouse motion events from this component.
void addMouseWheelListener(MouseWheelListener l)
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(Image image, int width, int height, ImageObserver observer)
Returns the status of the construction of a screen representation of the specified image.
int checkImage(Image image, ImageObserver observer)
Returns the status of the construction of a screen representation of the specified image.
protected AWTEvent coalesceEvents(AWTEvent existingEvent, AWTEvent newEvent)
Potentially coalesce an event being posted with an existing event.
boolean contains(Point p)
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(int width, int height)
Creates an off-screen drawable image to be used for double buffering.
Image createImage(ImageProducer producer)
Creates an image from the specified image producer.
VolatileImage createVolatileImage(int width, int height)
Creates a volatile off-screen drawable image to be used for double buffering.
VolatileImage createVolatileImage(int width, int height, ImageCapabilities caps)
Creates a volatile off-screen drawable image, with the given capabilities.
protected final void disableEvents(long eventsToDisable)
Disables the events defined by the specified event mask parameter from being delivered to this component.
final void dispatchEvent(AWTEvent e)
Dispatches an event to this component or one of its sub components.
void enable(boolean b)
Deprecated.
As of JDK version 1.1, replaced by setEnabled(boolean).
protected final void enableEvents(long eventsToEnable)
Enables the events defined by the specified event mask parameter to be delivered to this component.
void enableInputMethods(boolean enable)
Enables or disables input method support for this component.
void firePropertyChange(String propertyName, byte oldValue, byte newValue)
Reports a bound property change.
void firePropertyChange(String propertyName, char oldValue, char newValue)
Reports a bound property change.
void firePropertyChange(String propertyName, double oldValue, double newValue)
Reports a bound property change.
void firePropertyChange(String propertyName, float oldValue, float newValue)
Reports a bound property change.
void firePropertyChange(String propertyName, long oldValue, long newValue)
Reports a bound property change.
void firePropertyChange(String propertyName, short oldValue, short newValue)
Reports a bound property change.
protected void firePropertyChange(String propertyName, Object oldValue, Object newValue)
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(String propertyName)
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(Event evt, Object what)
Deprecated.
As of JDK version 1.1, replaced by processFocusEvent(FocusEvent).
boolean handleEvent(Event evt)
Deprecated.
As of JDK version 1.1 replaced by processEvent(AWTEvent).
boolean hasFocus()
Returns true if this Component is the focus owner.
boolean imageUpdate(Image img, int infoflags, int x, int y, int w, int h)
Repaints the component when the image has changed.
boolean inside(int x, int y)
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(Event evt, int key)
Deprecated.
As of JDK version 1.1, replaced by processKeyEvent(KeyEvent).
boolean keyUp(Event evt, int key)
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(PrintStream out)
Prints a listing of this component to the specified output stream.
void list(PrintWriter out)
Prints a listing to the specified print writer.
Point location()
Deprecated.
As of JDK version 1.1, replaced by getLocation().
boolean lostFocus(Event evt, Object what)
Deprecated.
As of JDK version 1.1, replaced by processFocusEvent(FocusEvent).
boolean mouseDown(Event evt, int x, int y)
Deprecated.
As of JDK version 1.1, replaced by processMouseEvent(MouseEvent).
boolean mouseDrag(Event evt, int x, int y)
Deprecated.
As of JDK version 1.1, replaced by processMouseMotionEvent(MouseEvent).
boolean mouseEnter(Event evt, int x, int y)
Deprecated.
As of JDK version 1.1, replaced by processMouseEvent(MouseEvent).
boolean mouseExit(Event evt, int x, int y)
Deprecated.
As of JDK version 1.1, replaced by processMouseEvent(MouseEvent).
boolean mouseMove(Event evt, int x, int y)
Deprecated.
As of JDK version 1.1, replaced by processMouseMotionEvent(MouseEvent).
boolean mouseUp(Event evt, int x, int y)
Deprecated.
As of JDK version 1.1, replaced by processMouseEvent(MouseEvent).
void move(int x, int y)
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(Graphics g)
Paints this component and all of its subcomponents.
boolean postEvent(Event e)
Deprecated.
As of JDK version 1.1, replaced by dispatchEvent(AWTEvent).
boolean prepareImage(Image image, int width, int height, ImageObserver observer)
Prepares an image for rendering on this component at the specified width and height.
boolean prepareImage(Image image, ImageObserver observer)
Prepares an image for rendering on this component.
protected void processComponentEvent(ComponentEvent e)
Processes component events occurring on this component by dispatching them to any registered ComponentListener objects.
protected void processFocusEvent(FocusEvent e)
Processes focus events occurring on this component by dispatching them to any registered FocusListener objects.
protected void processHierarchyBoundsEvent(HierarchyEvent e)
Processes hierarchy bounds events occurring on this component by dispatching them to any registered HierarchyBoundsListener objects.
protected void processHierarchyEvent(HierarchyEvent e)
Processes hierarchy events occurring on this component by dispatching them to any registered HierarchyListener objects.
protected void processInputMethodEvent(InputMethodEvent e)
Processes input method events occurring on this component by dispatching them to any registered InputMethodListener objects.
protected void processMouseWheelEvent(MouseWheelEvent e)
Processes mouse wheel events occurring on this component by dispatching them to any registered MouseWheelListener objects.
void remove(MenuComponent popup)
Removes the specified popup menu from the component.
void removeComponentListener(ComponentListener l)
Removes the specified component listener so that it no longer receives component events from this component.
void removeFocusListener(FocusListener l)
Removes the specified focus listener so that it no longer receives focus events from this component.
void removeHierarchyBoundsListener(HierarchyBoundsListener l)
Removes the specified hierarchy bounds listener so that it no longer receives hierarchy bounds events from this component.
void removeHierarchyListener(HierarchyListener l)
Removes the specified hierarchy listener so that it no longer receives hierarchy changed events from this component.
void removeInputMethodListener(InputMethodListener l)
Removes the specified input method listener so that it no longer receives input method events from this component.
void removeKeyListener(KeyListener l)
Removes the specified key listener so that it no longer receives key events from this component.
void removeMouseListener(MouseListener l)
Removes the specified mouse listener so that it no longer receives mouse events from this component.
void removeMouseMotionListener(MouseMotionListener l)
Removes the specified mouse motion listener so that it no longer receives mouse motion events from this component.
void removeMouseWheelListener(MouseWheelListener l)
Removes the specified mouse wheel listener so that it no longer receives mouse wheel events from this component.
void removePropertyChangeListener(PropertyChangeListener listener)
Removes a PropertyChangeListener from the listener list.
void removePropertyChangeListener(String propertyName, PropertyChangeListener listener)
Removes a PropertyChangeListener from the listener list for a specific property.
void repaint()
Repaints this component.
void repaint(int x, int y, int width, int height)
Repaints the specified rectangle of this component.
void repaint(long tm)
Repaints the component.
protected boolean requestFocus(boolean temporary, FocusEvent.Cause cause)
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(FocusEvent.Cause cause)
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(FocusEvent.Cause cause)
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(int width, int height)
Deprecated.
As of JDK version 1.1, replaced by setSize(int, int).
void resize(Dimension d)
Deprecated.
As of JDK version 1.1, replaced by setSize(Dimension).
void setBounds(int x, int y, int width, int height)
Moves and resizes this component.
void setBounds(Rectangle r)
Moves and resizes this component to conform to the new bounding rectangle r.
void setCursor(Cursor cursor)
Sets the cursor image to the specified cursor.
void setDropTarget(DropTarget dt)
Associate a DropTarget with this component.
void setFocusable(boolean focusable)
Sets the focusable state of this Component to the specified value.
void setFocusTraversalKeysEnabled(boolean focusTraversalKeysEnabled)
Sets whether focus traversal keys are enabled for this Component.
void setIgnoreRepaint(boolean ignoreRepaint)
Sets whether or not paint messages received from the operating system should be ignored.
void setLocale(Locale l)
Sets the locale of this component.
void setLocation(int x, int y)
Moves this component to a new location.
void setLocation(Point p)
Moves this component to a new location.
void setMixingCutoutShape(Shape shape)
Sets a 'mixing-cutout' shape for this lightweight component.
void setName(String name)
Sets the name of the component to the specified string.
void setSize(int width, int height)
Resizes this component so that it has width width and height height.
void setSize(Dimension d)
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(boolean b)
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(Object obj)
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(long timeoutMillis)
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(long timeoutMillis, int nanos)
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
Vertical split indicates the Components are split along the y axis. For example the two Components will be split one on top of the other.
See Also:
  • Constant Field Values

HORIZONTAL_SPLIT

public static final int HORIZONTAL_SPLIT
Horizontal split indicates the Components are split along the x axis. For example the two Components will be split one to the left of the other.
See Also:
  • Constant Field Values

LEFT

public static final String LEFT
Used to add a Component to the left of the other Component.
See Also:
  • Constant Field Values

RIGHT

public static final String RIGHT
Used to add a Component to the right of the other Component.
See Also:
  • Constant Field Values

TOP

public static final String TOP
Used to add a Component above the other Component.
See Also:
  • Constant Field Values

BOTTOM

public static final String BOTTOM
Used to add a Component below the other Component.
See Also:
  • Constant Field Values

DIVIDER

public static final String DIVIDER
Used to add a Component that will represent the divider.
See Also:
  • Constant Field Values

ORIENTATION_PROPERTY

public static final String ORIENTATION_PROPERTY
Bound property name for orientation (horizontal or vertical).
See Also:
  • Constant Field Values

CONTINUOUS_LAYOUT_PROPERTY

public static final String CONTINUOUS_LAYOUT_PROPERTY
Bound property name for continuousLayout.
See Also:
  • Constant Field Values

DIVIDER_SIZE_PROPERTY

public static final String DIVIDER_SIZE_PROPERTY
Bound property name for border.
See Also:
  • Constant Field Values

ONE_TOUCH_EXPANDABLE_PROPERTY

public static final String ONE_TOUCH_EXPANDABLE_PROPERTY
Bound property for oneTouchExpandable.
See Also:
  • Constant Field Values

LAST_DIVIDER_LOCATION_PROPERTY

public static final String LAST_DIVIDER_LOCATION_PROPERTY
Bound property for lastLocation.
See Also:
  • Constant Field Values

DIVIDER_LOCATION_PROPERTY

public static final String DIVIDER_LOCATION_PROPERTY
Bound property for the dividerLocation.
Since:
1.3
See Also:
  • Constant Field Values

RESIZE_WEIGHT_PROPERTY

public static final String RESIZE_WEIGHT_PROPERTY
Bound property for weight.
Since:
1.3
See Also:
  • Constant Field Values

orientation

protected int orientation
How the views are split.

continuousLayout

protected boolean continuousLayout
Whether or not the views are continuously redisplayed while resizing.

leftComponent

protected Component leftComponent
The left or top component.

rightComponent

protected Component rightComponent
The right or bottom component.

dividerSize

protected int dividerSize
Size of the divider.

oneTouchExpandable

protected boolean oneTouchExpandable
Is a little widget provided to quickly expand/collapse the split pane?

lastDividerLocation

protected int lastDividerLocation
Previous location of the split pane.

Constructor Details

JSplitPane

public JSplitPane()
Creates a new JSplitPane configured to arrange the child components side-by-side horizontally, using two buttons for the components.

JSplitPane

@ConstructorProperties("orientation") public JSplitPane(int newOrientation)
Creates a new JSplitPane configured with the specified orientation.
Parameters:
newOrientation - JSplitPane.HORIZONTAL_SPLIT or JSplitPane.VERTICAL_SPLIT
Throws:
IllegalArgumentException - if orientation is not one of HORIZONTAL_SPLIT or VERTICAL_SPLIT.

JSplitPane

public JSplitPane(int newOrientation, boolean newContinuousLayout)
Creates a new JSplitPane with the specified orientation and redrawing style.
Parameters:
newOrientation - JSplitPane.HORIZONTAL_SPLIT or JSplitPane.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 - if orientation is not one of HORIZONTAL_SPLIT or VERTICAL_SPLIT

JSplitPane

public JSplitPane(int newOrientation, Component newLeftComponent, Component newRightComponent)
Creates a new JSplitPane with the specified orientation and the specified components.
Parameters:
newOrientation - JSplitPane.HORIZONTAL_SPLIT or JSplitPane.VERTICAL_SPLIT
newLeftComponent - the Component that will appear on the left of a horizontally-split pane, or at the top of a vertically-split pane
newRightComponent - the Component that will appear on the right of a horizontally-split pane, or at the bottom of a vertically-split pane
Throws:
IllegalArgumentException - if orientation is not one of: HORIZONTAL_SPLIT or VERTICAL_SPLIT

JSplitPane

public JSplitPane(int newOrientation, boolean newContinuousLayout, Component newLeftComponent, Component newRightComponent)
Creates a new JSplitPane with the specified orientation and redrawing style, and with the specified components.
Parameters:
newOrientation - JSplitPane.HORIZONTAL_SPLIT or JSplitPane.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 - the Component that will appear on the left of a horizontally-split pane, or at the top of a vertically-split pane
newRightComponent - the Component that will appear on the right of a horizontally-split pane, or at the bottom of a vertically-split pane
Throws:
IllegalArgumentException - if orientation is not one of HORIZONTAL_SPLIT or VERTICAL_SPLIT

Method Details

setComponentOrientation

public void setComponentOrientation(ComponentOrientation orientation)
Sets the language-sensitive orientation that is to be used to order the elements or text within this component. Language-sensitive 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:
setComponentOrientation in class Component
Parameters:
orientation - the orientation to be set
See Also:
  • ComponentOrientation
  • Component.invalidate()

setEnabled

public void setEnabled(boolean enabled)
Sets whether or not this component is enabled. A component that is enabled may respond to user input, while a component that is not enabled cannot respond to user input. Some components may alter their visual representation when they are disabled in order to provide feedback to the user that they cannot take input.

Note: Disabling a component does not disable its children.

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

Overrides:
setEnabled in class JComponent
Parameters:
enabled - true if this component should be enabled, false otherwise
See Also:
  • Component.isEnabled()
  • Component.isLightweight()

setUI

public void setUI(SplitPaneUI ui)
Sets the L&F object that renders this component.
Parameters:
ui - the SplitPaneUI L&F object
See Also:
  • UIDefaults.getUI(JComponent)

getUI

@BeanProperty(bound=false, expert=true, description="The L&F object that renders this component.") public SplitPaneUI getUI()
Returns the SplitPaneUI that is providing the current look and feel.
Overrides:
getUI in class JComponent
Returns:
the SplitPaneUI object that renders this component

updateUI

public void updateUI()
Notification from the UIManager that the L&F has changed. Replaces the current UI object with the latest version from the UIManager.
Overrides:
updateUI in class JComponent
See Also:
  • JComponent.updateUI()

getUIClassID

@BeanProperty(bound=false, expert=true, description="A string that specifies the name of the L&F class.") public String getUIClassID()
Returns the name of the L&F class that renders this component.
Overrides:
getUIClassID in class JComponent
Returns:
the string "SplitPaneUI"
See Also:
  • JComponent.getUIClassID()
  • UIDefaults.getUI(JComponent)

setDividerSize

@BeanProperty(description="The size of the divider.") public void setDividerSize(int newSize)
Sets the size of the divider. Divider sizes newSize < 0 are ignored.
Parameters:
newSize - an integer giving the size of the divider in pixels

getDividerSize

public int getDividerSize()
Returns the size of the divider.
Returns:
an integer giving the size of the divider in pixels

setLeftComponent

public void setLeftComponent(Component comp)
Sets the component to the left (or above) the divider.
Parameters:
comp - the Component to 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 component to the left (or above) the divider.
Returns:
the Component displayed in that position

setTopComponent

@BeanProperty(bound=false, description="The component above, or to the left of the divider.") public void setTopComponent(Component comp)
Sets the component above, or to the left of the divider.
Parameters:
comp - the Component to display in that position

getTopComponent

public Component getTopComponent()
Returns the component above, or to the left of the divider.
Returns:
the Component displayed in that position

setRightComponent

@BeanProperty(bound=false, preferred=true, description="The component to the right (or below) the divider.") public void setRightComponent(Component comp)
Sets the component to the right (or below) the divider.
Parameters:
comp - the Component to display in that position

getRightComponent

public Component getRightComponent()
Returns the component to the right (or below) the divider.
Returns:
the Component displayed in that position

setBottomComponent

@BeanProperty(bound=false, description="The component below, or to the right of the divider.") public void setBottomComponent(Component comp)
Sets the component below, or to the right of the divider.
Parameters:
comp - the Component to display in that position

getBottomComponent

public Component getBottomComponent()
Returns the component below, or to the right of the divider.
Returns:
the Component displayed in that position

setOneTouchExpandable

@BeanProperty(description="UI widget on the divider to quickly expand/collapse the divider.") public void setOneTouchExpandable(boolean newValue)
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. 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 - true to specify that the split pane should provide a collapse/expand widget
See Also:
  • isOneTouchExpandable()

isOneTouchExpandable

public boolean isOneTouchExpandable()
Gets the oneTouchExpandable property.
Returns:
the value of the oneTouchExpandable property
See Also:
  • setOneTouchExpandable(boolean)

setLastDividerLocation

@BeanProperty(description="The last location the divider was at.") public void setLastDividerLocation(int newLastLocation)
Sets the last location the divider was at to 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 the last location the divider was at.
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)
Sets the orientation, or how the splitter is divided. The options are:
  • 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 the orientation.
Returns:
an integer giving the orientation
See Also:
  • setOrientation(int)

setContinuousLayout

@BeanProperty(description="Whether the child components are continuously redisplayed and laid out during user intervention.") public void setContinuousLayout(boolean newContinuousLayout)
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. 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 - true if the components should continuously be redrawn as the divider changes position
See Also:
  • isContinuousLayout()

isContinuousLayout

public boolean isContinuousLayout()
Gets the continuousLayout property.
Returns:
the value of the continuousLayout property
See Also:
  • setContinuousLayout(boolean)

setResizeWeight

@BeanProperty(description="Specifies how to distribute extra space when the split pane resizes.") public void setResizeWeight(double value)
Specifies how to distribute extra space when the size of the split pane changes. A value of 0, the default, indicates the right/bottom component gets all the extra space (the left/top component acts fixed), where as a value of 1 specifies the left/top component gets all the extra space (the right/bottom component acts fixed). Specifically, the left/top component gets (weight * diff) extra space and the right/bottom component gets (1 - weight) * diff extra space.
Parameters:
value - as described above
Throws:
IllegalArgumentException - if value is < 0 or > 1
Since:
1.3

getResizeWeight

public double getResizeWeight()
Returns the number that determines how extra space is distributed.
Returns:
how extra space is to be distributed on a resize of the split pane
Since:
1.3

resetToPreferredSizes

public void resetToPreferredSizes()
Lays out the 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)
Sets the divider location as a percentage of the 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)
Sets the location of the divider. This is passed off to the look and feel implementation, and then listeners are notified. A value less than 0 implies the divider should be reset to a value that attempts to honor the preferred size of the left/top component. After notifying the listeners, the last divider location is updated, via setLastDividerLocation.
Parameters:
location - an int specifying a UI-specific value (typically a pixel count)

getDividerLocation

public int getDividerLocation()
Returns the last value passed to 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 the minimum location of the divider from the look and feel implementation.
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 the maximum location of the divider from the look and feel implementation.
Returns:
an integer specifying a UI-specific value for the maximum location (typically a pixel count); or -1 if the UI is null

remove

public void remove(Component component)
Removes the child component, component from the pane. Resets the leftComponent or rightComponent instance variable, as necessary.
Overrides:
remove in class Container
Parameters:
component - the Component to remove
See Also:
  • Container.add(Component)
  • Container.invalidate()
  • Container.validate()
  • Container.remove(int)

remove

public void remove(int index)
Removes the Component at the specified index. Updates the leftComponent and rightComponent instance variables as necessary, and then messages super.
Overrides:
remove in class Container
Parameters:
index - an integer specifying the component to remove, where 1 specifies the left/top component and 2 specifies the bottom/right component
See Also:
  • Container.add(Component)
  • Container.invalidate()
  • Container.validate()
  • Container.getComponentCount()

removeAll

public void removeAll()
Removes all the child components from the split pane. Resets the leftComponent and rightComponent instance variables.
Overrides:
removeAll in class Container
See Also:
  • Container.add(Component)
  • Container.remove(int)
  • Container.invalidate()

isValidateRoot

@BeanProperty(hidden=true) public 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.
Overrides:
isValidateRoot in class JComponent
Returns:
true
See Also:
  • JComponent.revalidate()
  • Container.isValidateRoot()

addImpl

protected void addImpl(Component comp, Object constraints, int index)
Adds the specified component to this split pane. If 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
If the constraints object is null, the component is added in the first available position (left/top if open, else right/bottom).
Overrides:
addImpl in class Container
Parameters:
comp - the component to add
constraints - an Object specifying the layout constraints (position) for this component
index - an integer specifying the index in the container's list.
Throws:
IllegalArgumentException - if the constraints object does not match an existing component
See Also:
  • Container.addImpl(Component, Object, int)

paintChildren

protected void paintChildren(Graphics g)
Subclassed to message the UI with finishedPaintingChildren after super has been messaged, as well as painting the border.
Overrides:
paintChildren in class JComponent
Parameters:
g - the Graphics context within which to paint
See Also:
  • JComponent.paint(Graphics)
  • Container.paint(Graphics)

paramString

protected String paramString()
Returns a string representation of this 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:
paramString in class JComponent
Returns:
a string representation of this JSplitPane.

getAccessibleContext

@BeanProperty(bound=false, expert=true, description="The AccessibleContext associated with this SplitPane.") public AccessibleContext getAccessibleContext()
Gets the AccessibleContext associated with this JSplitPane. For split panes, the AccessibleContext takes the form of an AccessibleJSplitPane. A new AccessibleJSplitPane instance is created if necessary.
Specified by:
getAccessibleContext in interface Accessible
Overrides:
getAccessibleContext in class Component
Returns:
an AccessibleJSplitPane that serves as the AccessibleContext of this JSplitPane

Report a bug or suggest an enhancement
For further API reference and developer documentation see the Java SE Documentation, which contains more detailed, developer-targeted descriptions with conceptual overviews, definitions of terms, workarounds, and working code examples. Other versions.
Java is a trademark or registered trademark of Oracle and/or its affiliates in the US and other countries.
Copyright © 1993, 2026, Oracle and/or its affiliates, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
All rights reserved. Use is subject to license terms and the documentation redistribution policy.

© 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.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API