Module java.desktop
Package javax.swing

Class JSeparator

java.lang.Object
java.awt.Component
java.awt.Container
javax.swing.JComponent
javax.swing.JSeparator
All Implemented Interfaces:
ImageObserver, MenuContainer, Serializable, Accessible, SwingConstants
Direct Known Subclasses:
JPopupMenu.Separator, JToolBar.Separator
@JavaBean(defaultProperty="UI", description="A divider between menu items.") public class JSeparator extends JComponent implements SwingConstants, Accessible
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 XMLEncoder.

Since:
1.2

  • Constructor Details

    • JSeparator

      public JSeparator()
      Creates a new horizontal separator.

    • JSeparator

      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

  • Method Details

    • getUI

      public SeparatorUI getUI()
      Returns the L&F object that renders this component.
      Overrides:
      getUI in class JComponent
      Returns:
      the SeparatorUI object that renders this component

    • setUI

      @BeanProperty(hidden=true, visualUpdate=true, description="The UI object that implements the Component\'s LookAndFeel.") public void setUI​(SeparatorUI ui)
      Sets the L&F object that renders this component.
      Parameters:
      ui - the SeparatorUI L&F object
      See Also:
      UIDefaults.getUI(javax.swing.JComponent)

    • updateUI

      public void updateUI()
      Resets the UI property to a value from the current look and feel.
      Overrides:
      updateUI in class JComponent
      See Also:
      JComponent.updateUI()

    • getUIClassID

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

    • getOrientation

      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.
      See Also:
      SwingConstants, setOrientation(int)

    • setOrientation

      @BeanProperty(preferred=true, visualUpdate=true, enumerationValues={"SwingConstants.HORIZONTAL","SwingConstants.VERTICAL"}, description="The orientation of the separator.") 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
      See Also:
      SwingConstants, getOrientation()

    • paramString

      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.
      Overrides:
      paramString in class JComponent
      Returns:
      a string representation of this JSeparator

    • getAccessibleContext

      @BeanProperty(bound=false) 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.
      Specified by:
      getAccessibleContext in interface Accessible
      Overrides:
      getAccessibleContext in class Component
      Returns:
      an AccessibleJSeparator that serves as the AccessibleContext of this JSeparator