public class

JSeparator

extends JComponent
implements Accessible SwingConstants
java.lang.Object
   ↳ java.awt.Component
     ↳ java.awt.Container
       ↳ javax.swing.JComponent
         ↳ javax.swing.JSeparator
Known Direct Subclasses

Class Overview

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 JavaBeansTM has been added to the java.beans package. Please see XMLEncoder.

Summary

Nested Classes
class JSeparator.AccessibleJSeparator This class implements accessibility support for the JSeparator class. 
[Expand]
Inherited Constants
From class javax.swing.JComponent
From class java.awt.Component
From interface java.awt.image.ImageObserver
From interface javax.swing.SwingConstants
[Expand]
Inherited Fields
From class javax.swing.JComponent
Public Constructors
JSeparator()
Creates a new horizontal separator.
JSeparator(int orientation)
Creates a new separator with the specified horizontal or vertical orientation.
Public Methods
AccessibleContext getAccessibleContext()
Gets the AccessibleContext associated with this JSeparator.
int getOrientation()
Returns the orientation of this separator.
SeparatorUI getUI()
Returns the L&F object that renders this component.
String getUIClassID()
Returns the name of the L&F class that renders this component.
void setOrientation(int orientation)
Sets the orientation of the separator.
void setUI(SeparatorUI ui)
Sets the L&F object that renders this component.
void updateUI()
Resets the UI property to a value from the current look and feel.
Protected Methods
String paramString()
Returns a string representation of this JSeparator.
[Expand]
Inherited Methods
From class javax.swing.JComponent
From class java.awt.Container
From class java.awt.Component
From class java.lang.Object
From interface java.awt.MenuContainer
From interface java.awt.image.ImageObserver
From interface javax.accessibility.Accessible

Public Constructors

public JSeparator ()

Creates a new horizontal separator.

public JSeparator (int orientation)

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

Parameters
orientation an integer specifying SwingConstants.HORIZONTAL or SwingConstants.VERTICAL
Throws
IllegalArgumentException if orientation is neither SwingConstants.HORIZONTAL nor SwingConstants.VERTICAL

Public Methods

public AccessibleContext 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
  • an AccessibleJSeparator that serves as the AccessibleContext of this JSeparator

public int getOrientation ()

Returns the orientation of this separator.

Returns
  • The value of the orientation property, one of the following constants defined in SwingConstants: VERTICAL, or HORIZONTAL.

public SeparatorUI getUI ()

Returns the L&F object that renders this component.

Returns
  • the SeparatorUI object that renders this component

public String getUIClassID ()

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

Returns
  • the string "SeparatorUI"

public void setOrientation (int orientation)

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

Parameters
orientation either SwingConstants.HORIZONTAL or SwingConstants.VERTICAL
Throws
IllegalArgumentException if orientation is neither SwingConstants.HORIZONTAL nor SwingConstants.VERTICAL

public void setUI (SeparatorUI ui)

Sets the L&F object that renders this component.

Parameters
ui the SeparatorUI L&F object

public void updateUI ()

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

See Also

Protected Methods

protected String 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
  • a string representation of this JSeparator