JSeparator provides a general purpose component for implementing divider lines - most commonly used as a divider between menu items that breaks them up into logical groupings. Instead of using JSeparator directly, you can use the JMenu or JPopupMenu addSeparator method to create and add a separator. JSeparators may also be used elsewhere in a GUI wherever a visual divider is useful.

For more information and examples see How to Use Menus, a section in The Java Tutorial.

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 java.beans.XMLEncoder.

Nested and Inner Type Summary

Modifier and Type	Class and Description
protected class	JSeparator.AccessibleJSeparator This class implements accessibility support for the `JSeparator` class.

Field Summary

Modifier and Type	Field and Description
private int	orientation
private static final String	uiClassID Hides javax.swing.JComponent.uiClassID.

Inherited from javax.swing.JComponent:: DEBUG_GRAPHICS_LOADED focusController ivSourceComponent listenerList paintingChild TOOL_TIP_TEXT_KEY ui UNDEFINED_CONDITION WHEN_ANCESTOR_OF_FOCUSED_COMPONENT WHEN_FOCUSED WHEN_IN_FOCUSED_WINDOW

Constructor Summary

Access	Constructor and Description
public	JSeparator() Creates a new horizontal separator.
public	JSeparator(int an integer specifying `SwingConstants.HORIZONTAL` or `SwingConstants.VERTICAL` orientation) Creates a new separator with the specified horizontal or vertical orientation.

Method Summary

Modifier and Type	Method and Description
private void	checkOrientation(int orientation)
public AccessibleContext	Returns: an AccessibleJSeparator that serves as the AccessibleContext of this JSeparator getAccessibleContext() Overrides java.awt.Component.getAccessibleContext. Implements javax.accessibility.Accessible.getAccessibleContext. Gets the AccessibleContext associated with this JSeparator.
public int	Returns: The value of the orientation property, one of the following constants defined in `SwingConstants`: `VERTICAL`, or `HORIZONTAL`. getOrientation() Returns the orientation of this separator.
public SeparatorUI	Returns: the SeparatorUI object that renders this component getUI() Overrides javax.swing.JComponent.getUI. Returns the L&F object that renders this component.
public String	Returns: the string "SeparatorUI" getUIClassID() Overrides javax.swing.JComponent.getUIClassID. Returns the name of the L&F class that renders this component.
protected String	Returns: a string representation of this `JSeparator` paramString() Overrides javax.swing.JComponent.paramString. Returns a string representation of this `JSeparator`.
public void	setOrientation(int either `SwingConstants.HORIZONTAL` or `SwingConstants.VERTICAL` orientation) Sets the orientation of the separator.
public void	setUI(SeparatorUI the SeparatorUI L&F object ui) Sets the L&F object that renders this component.
public void	updateUI() Overrides javax.swing.JComponent.updateUI. Resets the UI property to a value from the current look and feel.
private void	writeObject(ObjectOutputStream s) Hides javax.swing.JComponent.writeObject. See `readObject` and `writeObject` in `JComponent` for more information about serialization in Swing.

Inherited from javax.swing.JComponent:: _paintImmediately addAncestorListener addNotify addVetoableChangeListener alwaysOnTop checkIfChildObscuredBySibling clientPropertyChanged componentInputMapChanged computeVisibleRect computeVisibleRect compWriteObjectNotify contains createToolTip disable dndDone dropLocationForPoint enable firePropertyChange firePropertyChange firePropertyChange fireVetoableChange getActionForKeyStroke getActionMap getActionMap getAlignmentX getAlignmentY getAncestorListeners getAutoscrolls getBaseline getBaselineResizeBehavior getBorder getBounds getClientProperty getComponentGraphics getComponentPopupMenu getConditionForKeyStroke getCreatedDoubleBuffer getDebugGraphicsOptions getDefaultLocale getFontMetrics getGraphics getGraphicsInvoked getHeight getInheritsPopupMenu getInputMap getInputMap getInputMap getInputVerifier getInsets getInsets getListeners getLocation getManagingFocusBackwardTraversalKeys getManagingFocusForwardTraversalKeys getMaximumSize getMinimumSize getNextFocusableComponent getPopupLocation getPreferredSize getRegisteredKeyStrokes getRootPane getSize getToolTipLocation getToolTipText getToolTipText getTopLevelAncestor getTransferHandler getVerifyInputWhenFocusTarget getVetoableChangeListeners getVisibleRect getWidth getWriteObjCounter getX getY grabFocus hide isDoubleBuffered isLightweightComponent isManagingFocus isOpaque isOptimizedDrawingEnabled isPainting isPaintingForPrint isPaintingOrigin isPaintingTile isRequestFocusEnabled isValidateRoot paint paintBorder paintChildren paintComponent paintForceDoubleBuffered paintImmediately paintImmediately paintToOffscreen print printAll printBorder printChildren printComponent processComponentKeyEvent processKeyBinding processKeyBindings processKeyBindingsForAllComponents processKeyEvent processMouseEvent processMouseMotionEvent putClientProperty rectangleIsObscured registerKeyboardAction registerKeyboardAction removeAncestorListener removeNotify removeVetoableChangeListener repaint repaint requestDefaultFocus requestFocus requestFocus requestFocusInWindow requestFocusInWindow resetKeyboardActions reshape revalidate safelyGetGraphics safelyGetGraphics scrollRectToVisible setActionMap setAlignmentX setAlignmentY setAutoscrolls setBackground setBorder setComponentPopupMenu setCreatedDoubleBuffer setDebugGraphicsOptions setDefaultLocale setDoubleBuffered setDropLocation setEnabled setFocusTraversalKeys setFont setForeground setInheritsPopupMenu setInputMap setInputVerifier setMaximumSize setMinimumSize setNextFocusableComponent setOpaque setPaintingChild setPreferredSize setRequestFocusEnabled setToolTipText setTransferHandler setUI setUIProperty setVerifyInputWhenFocusTarget setVisible setWriteObjCounter shouldDebugGraphics superProcessMouseMotionEvent unregisterKeyboardAction update

Field Detail

orientation	back to summary
private int orientation

uiClassID back to summary

uiClassID	back to summary
private static final String uiClassID Hides javax.swing.JComponent.uiClassID. See Also `getUIClassID`, `readObject`

private static final String uiClassID

Hides javax.swing.JComponent.uiClassID.

See Also: getUIClassID, readObject

Constructor Detail

JSeparator	back to summary
public JSeparator() Creates a new horizontal separator.

JSeparator back to summary

JSeparator	back to summary
public JSeparator(int orientation) Creates a new separator with the specified horizontal or vertical orientation. Parameters orientation:int an integer specifying `SwingConstants.HORIZONTAL` or `SwingConstants.VERTICAL` Exceptions IllegalArgumentException: if `orientation` is neither `SwingConstants.HORIZONTAL` nor `SwingConstants.VERTICAL`

public JSeparator(int orientation)

Creates a new separator with the specified horizontal or vertical orientation.

Parameters

orientation:int: an integer specifying SwingConstants.HORIZONTAL or SwingConstants.VERTICAL

Exceptions

IllegalArgumentException:: if orientation is neither SwingConstants.HORIZONTAL nor SwingConstants.VERTICAL

Method Detail

checkOrientation	back to summary
private void checkOrientation(int orientation)

getAccessibleContext	back to summary
public AccessibleContext getAccessibleContext() Overrides java.awt.Component.getAccessibleContext. Implements javax.accessibility.Accessible.getAccessibleContext. Gets the AccessibleContext associated with this JSeparator. For separators, the AccessibleContext takes the form of an AccessibleJSeparator. A new AccessibleJSeparator instance is created if necessary. Returns:AccessibleContext an AccessibleJSeparator that serves as the AccessibleContext of this JSeparator Annotations @BeanProperty bound:false

getAccessibleContext

back to summary

public AccessibleContext getAccessibleContext()

Overrides java.awt.Component.getAccessibleContext.

Implements javax.accessibility.Accessible.getAccessibleContext.

Gets the AccessibleContext associated with this JSeparator. For separators, the AccessibleContext takes the form of an AccessibleJSeparator. A new AccessibleJSeparator instance is created if necessary.

Returns:AccessibleContext

an AccessibleJSeparator that serves as the AccessibleContext of this JSeparator

Annotations

@BeanProperty
bound:false

getOrientation back to summary

getOrientation	back to summary
public int getOrientation() Returns the orientation of this separator. Returns:int The value of the orientation property, one of the following constants defined in `SwingConstants`: `VERTICAL`, or `HORIZONTAL`. See Also `SwingConstants`, `setOrientation`

public int getOrientation()

Returns the orientation of this separator.

Returns:int: The value of the orientation property, one of the following constants defined in SwingConstants: VERTICAL, or HORIZONTAL.
See Also: SwingConstants, setOrientation

getUI	back to summary
public SeparatorUI getUI() Overrides javax.swing.JComponent.getUI. Returns the L&F object that renders this component. Returns:SeparatorUI the SeparatorUI object that renders this component

getUI

back to summary

public SeparatorUI getUI()

Overrides javax.swing.JComponent.getUI.

Returns the L&F object that renders this component.

Returns:SeparatorUI: the SeparatorUI object that renders this component

getUIClassID back to summary

getUIClassID	back to summary
public String getUIClassID() Overrides javax.swing.JComponent.getUIClassID. Returns the name of the L&F class that renders this component. Returns:String the string "SeparatorUI" Annotations @BeanProperty bound:false See Also `JComponent#getUIClassID`, `UIDefaults#getUI`

public String getUIClassID()

Overrides javax.swing.JComponent.getUIClassID.

Returns the name of the L&F class that renders this component.

Returns:String

the string "SeparatorUI"

Annotations

@BeanProperty
bound:false

paramString back to summary

paramString	back to summary
protected String paramString() Overrides javax.swing.JComponent.paramString. Returns a string representation of this `JSeparator`. 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`. Returns:String a string representation of this `JSeparator`

protected String paramString()

Overrides javax.swing.JComponent.paramString.

Returns a string representation of this JSeparator. 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.

Returns:String: a string representation of this JSeparator

setOrientation back to summary

setOrientation	back to summary
public void setOrientation(int orientation) Sets the orientation of the separator. The default value of this property is HORIZONTAL. Parameters orientation:int either `SwingConstants.HORIZONTAL` or `SwingConstants.VERTICAL` Annotations @BeanProperty preferred:true visualUpdate:true enumerationValues:SwingConstants.HORIZONTAL, SwingConstants.VERTICAL description:The orientation of the separator. Exceptions IllegalArgumentException: if `orientation` is neither `SwingConstants.HORIZONTAL` nor `SwingConstants.VERTICAL` See Also `SwingConstants`, `getOrientation`

public void setOrientation(int orientation)

Sets the orientation of the separator. The default value of this property is HORIZONTAL.

Parameters

orientation:int: either SwingConstants.HORIZONTAL or SwingConstants.VERTICAL

Annotations

@BeanProperty
preferred:true
visualUpdate:true
enumerationValues:SwingConstants.HORIZONTAL, SwingConstants.VERTICAL
description:The orientation of the separator.

Exceptions

IllegalArgumentException:: if orientation is neither SwingConstants.HORIZONTAL nor SwingConstants.VERTICAL

See Also

SwingConstants, getOrientation

setUI back to summary

setUI	back to summary
public void setUI(SeparatorUI ui) Sets the L&F object that renders this component. Parameters ui:SeparatorUI the SeparatorUI L&F object Annotations @BeanProperty hidden:true visualUpdate:true description:The UI object that implements the Component\'s LookAndFeel. See Also `UIDefaults#getUI`

public void setUI(SeparatorUI ui)

Sets the L&F object that renders this component.

Parameters

ui:SeparatorUI: the SeparatorUI L&F object

Annotations

@BeanProperty
hidden:true
visualUpdate:true
description:The UI object that implements the Component\'s LookAndFeel.

See Also

UIDefaults#getUI

updateUI back to summary

updateUI	back to summary
public void updateUI() Overrides javax.swing.JComponent.updateUI. Resets the UI property to a value from the current look and feel. See Also `JComponent#updateUI`

public void updateUI()

Overrides javax.swing.JComponent.updateUI.

Resets the UI property to a value from the current look and feel.

See Also: JComponent#updateUI

writeObject back to summary

writeObject	back to summary
private void writeObject(ObjectOutputStream s) throws IOException Hides javax.swing.JComponent.writeObject. See `readObject` and `writeObject` in `JComponent` for more information about serialization in Swing. Annotations @Serial Exceptions IOException: Doc from java.awt.Container.writeObject. if an I/O error occurs

private void writeObject(ObjectOutputStream s) throws IOException

Hides javax.swing.JComponent.writeObject.

See readObject and writeObject in JComponent for more information about serialization in Swing.

Annotations

@Serial

Exceptions

IOException:

Doc from java.awt.Container.writeObject.

if an I/O error occurs

javax.swing back to summary

protected Class JSeparator.AccessibleJSeparator

Class Inheritance

extends AccessibleJComponent

java.lang.Object
javax.accessibility.AccessibleContext
java.awt.Component.AccessibleAWTComponent
java.awt.Container.AccessibleAWTContainer
javax.swing.JComponent.AccessibleJComponent
javax.swing.JSeparator.AccessibleJSeparator

Annotations

@SuppressWarnings:serial

This class implements accessibility support for the JSeparator class. It provides an implementation of the Java Accessibility API appropriate to separator user-interface elements.

Warning

Field Summary

Inherited from javax.swing.JComponent.AccessibleJComponent:: accessibleFocusHandler

Constructor Summary

Access	Constructor and Description
protected	AccessibleJSeparator() Constructs an `AccessibleJSeparator`.

Method Summary

Modifier and Type	Method and Description
public AccessibleRole	Returns: an instance of AccessibleRole describing the role of the object getAccessibleRole() Overrides javax.swing.JComponent.AccessibleJComponent.getAccessibleRole. Get the role of this object.

Inherited from javax.swing.JComponent.AccessibleJComponent:: addPropertyChangeListener getAccessibleChild getAccessibleChildrenCount getAccessibleDescription getAccessibleExtendedComponent getAccessibleKeyBinding getAccessibleName getAccessibleStateSet getBorderTitle getTitledBorderText getToolTipText removePropertyChangeListener

Constructor Detail

AccessibleJSeparator	back to summary
protected AccessibleJSeparator() Constructs an `AccessibleJSeparator`.

Method Detail

getAccessibleRole	back to summary
public AccessibleRole getAccessibleRole() Overrides javax.swing.JComponent.AccessibleJComponent.getAccessibleRole. Get the role of this object. Returns:AccessibleRole an instance of AccessibleRole describing the role of the object

getAccessibleRole

back to summary

public AccessibleRole getAccessibleRole()

Overrides javax.swing.JComponent.AccessibleJComponent.getAccessibleRole.

Get the role of this object.

Returns:AccessibleRole: an instance of AccessibleRole describing the role of the object

public Class JSeparator

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

protected Class JSeparator.AccessibleJSeparator

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail