com.jidesoft.swing
Class TitledSeparator

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  com.jidesoft.swing.TitledSeparator

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

public class TitledSeparator
extends JPanel

TitledSeparator is a component used for separating components on a panel or in a GUI. Each TitledSeparator is comprised of a title part and a graphical line. This component is preferred over TitledBorder when no full border is desired. To see this component in action, please refer to the TitledSeparator Demo.

Usage

This class presents a large number of constructors. As such, configurating the TitledSeparator can be wholly achieved at construction time. The list below shows the available constructors for this.

 TitledSeparator(String text)
 TitledSeparator(String text, int textAlignment)
 TitledSeparator(String text, int type, int textAlignment)
 TitledSeparator(JComponent component, int textAlignment)
 TitledSeparator(JComponent component, int type, int textAlignment)
 TitledSeparator(JComponent component, Border border, int alignment)
 TitledSeparator(JComponent component, int type, int textAlignment, int barAlignment)
 TitledSeparator(JComponent component, Border border, int textAlignment, int barAlignment)
 

Alternatively, you may use the empty constructor. When this approach is used, the text, border, text alignment and border alignment will need to be explicitly set. For example:-

 TitledSeparator separator = new TitledSeparator();
 separator.setLabelComponent(new JLabel("Configured TitledSeparator"));
 separator.setTextAlignment(right);
 separator.setBarAlignment(center);
 separator.setSeparatorBorder(new PartialEtchedBorder(PartialSide.SOUTH));
 

Please note, that this class should be constructed and modified from the EDT.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JPanel

JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

static String	PROPERTY_BAR_ALIGNMENT Identifies a change in the bar alignment.
static String	PROPERTY_LABEL Identifies the label has changed.
static String	PROPERTY_SEPARATOR_BORDER Identifies the border has changed.
static String	PROPERTY_TEXT_ALIGNMENT Identifies a change in the text alignment.
static int	TYPE_PARTIAL_ETCHED This value indicates an etched styled line separator.
static int	TYPE_PARTIAL_GRADIENT_LINE This value indicates a gradient line will be used for the separator.
static int	TYPE_PARTIAL_LINE This value indicates a solid line styled separator.

Fields inherited from class javax.swing.JComponent

accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

TitledSeparator()
Creates the default titled separator.

TitledSeparator(JComponent labelComponent, Border border, int textAlignment)
Creates a titled separator with the specified component, border and alignment.

TitledSeparator(JComponent labelComponent, Border border, int textAlignment, int barAlignment)
Creates a titled separator with the specified component, border, alignment and vertical alignment.

TitledSeparator(JComponent labelComponent, int textAlignment)
Creates a titled separator with the specified component and alignment.

TitledSeparator(JComponent labelComponent, int type, int textAlignment)
Creates a titled separator with the specified component, border type and alignment.

TitledSeparator(JComponent labelComponent, int type, int textAlignment, int barAlignment)
Creates a titled separator with the specified component, border type, alignment and vertical alignment.

TitledSeparator(String text)
Creates a default titled separator with the specified text.

TitledSeparator(String text, int textAlignment)
Creates a titled separator with the specified text and alignment.

TitledSeparator(String text, int type, int textAlignment)
Creates a titled separator with the specified text, border type and alignment.

Method Summary

int	getBarAlignment() Returns the bars vertical alignment.
JComponent	getLabelComponent() Returns the label part of this Titled Separator.
Border	getSeparatorBorder() Returns the border type.
int	getTextAlignment() Returns the texts horizontal alignment.
void	setBarAlignment(int barAlignment) Sets the bars vertical alignment.
void	setLabelComponent(JComponent labelComponent) Sets the labelComponent part of this Titled Separator.
void	setSeparatorBorder(Border border) Sets the border to be used as the graphical line region of this Titled Separator.
void	setTextAlignment(int textAlignment) Sets the texts horizontal alignment.
void	validateTitledSeparator() Responsible for configurating this TitledSeparator.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, 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, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, 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, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, 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, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusBackward, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.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, 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, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, 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, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

TYPE_PARTIAL_ETCHED

public static final int TYPE_PARTIAL_ETCHED

This value indicates an etched styled line separator.

See Also:

Constant Field Values

TYPE_PARTIAL_LINE

public static final int TYPE_PARTIAL_LINE

This value indicates a solid line styled separator.

See Also:

Constant Field Values

TYPE_PARTIAL_GRADIENT_LINE

public static final int TYPE_PARTIAL_GRADIENT_LINE

This value indicates a gradient line will be used for the separator.

See Also:

Constant Field Values

PROPERTY_LABEL

public static final String PROPERTY_LABEL

Identifies the label has changed.

See Also:

setLabelComponent(javax.swing.JComponent), Constant Field Values

PROPERTY_SEPARATOR_BORDER

public static final String PROPERTY_SEPARATOR_BORDER

Identifies the border has changed.

See Also:

setSeparatorBorder(javax.swing.border.Border), Constant Field Values

PROPERTY_BAR_ALIGNMENT

public static final String PROPERTY_BAR_ALIGNMENT

Identifies a change in the bar alignment.

See Also:

setBarAlignment(int), Constant Field Values

PROPERTY_TEXT_ALIGNMENT

public static final String PROPERTY_TEXT_ALIGNMENT

Identifies a change in the text alignment.

See Also:

setTextAlignment(int), Constant Field Values

Constructor Detail

TitledSeparator

public TitledSeparator()

Creates the default titled separator.

TitledSeparator

public TitledSeparator(String text)

Creates a default titled separator with the specified text.

Parameters:

text - the title of this titled separator

TitledSeparator

public TitledSeparator(String text,
                       int textAlignment)

Creates a titled separator with the specified text and alignment. The alignment determines whether the text will lye on the right or left of the separator line.

Parameters:

text - the title of this titled separator

textAlignment - Valid values are: SwingConstants.LEFT, SwingConstants.RIGHT, SwingConstants.LEADING or SwingConstants.TRAILING.

TitledSeparator

public TitledSeparator(String text,
                       int type,
                       int textAlignment)

Creates a titled separator with the specified text, border type and alignment. The alignment determines whether the text will lye on the right or left of the separator line.

Parameters:

text - the title of this titled separator

type - the style of border used as the separator line. Valid values are:- TitledSeparator.TYPE_PARTIAL_ETCHED, TitledSeparator.TYPE_PARTIAL_LINE or TitledSeparator.TYPE_PARTIAL_GRADIENT_LINE.

textAlignment - Valid values are: SwingConstants.LEFT, SwingConstants.RIGHT, SwingConstants.LEADING or SwingConstants.TRAILING.

TitledSeparator

public TitledSeparator(JComponent labelComponent,
                       int textAlignment)

Creates a titled separator with the specified component and alignment. The alignment determines whether the specified component will lye on the right or left of the separator line.

Parameters:

labelComponent - the component to be used as the titled part of this separator

textAlignment - Valid values are: SwingConstants.LEFT, SwingConstants.RIGHT, SwingConstants.LEADING or SwingConstants.TRAILING.

TitledSeparator

public TitledSeparator(JComponent labelComponent,
                       int type,
                       int textAlignment)

Creates a titled separator with the specified component, border type and alignment. The alignment determines whether the specified component will lye on the right or left of the separator line.

Parameters:

labelComponent - the component to be used as the titled part of this separator

type - the style of border used as the separator line. Valid values are:- TitledSeparator.TYPE_PARTIAL_ETCHED, TitledSeparator.TYPE_PARTIAL_LINE or TitledSeparator.TYPE_PARTIAL_GRADIENT_LINE.

textAlignment - Valid values are: SwingConstants.LEFT, SwingConstants.RIGHT, SwingConstants.LEADING or SwingConstants.TRAILING.

TitledSeparator

public TitledSeparator(JComponent labelComponent,
                       Border border,
                       int textAlignment)

Creates a titled separator with the specified component, border and alignment. The alignment determines whether the specified component will lye on the right or left of the separator line.

Parameters:

labelComponent - the component to be used as the titled part of this separator

border - the border to be used as the separator line

textAlignment - Valid values are: SwingConstants.LEFT, SwingConstants.RIGHT, SwingConstants.LEADING or SwingConstants.TRAILING.

TitledSeparator

public TitledSeparator(JComponent labelComponent,
                       int type,
                       int textAlignment,
                       int barAlignment)

Creates a titled separator with the specified component, border type, alignment and vertical alignment. The alignment determines whether the specified component will lye on the right or left of the separator line. The vertical alignment refers to the alignment of the separator line -- top, middle or bottom. Whenspecifyingg a border, the border is set with default values, for example: both TYPE_PARTIAL_LINE and TYPE_PARTIAL_LINE are configured with a 'thickness' of one pixel. If the the border required is not the default version, please use another constructor: TitledSeparator(component, border, alignment, verticalAlignment).

Parameters:

labelComponent - the component to be used as the titled part of this separator

type - the style of border used as the separator line. Valid values are:- TitledSeparator.TYPE_PARTIAL_ETCHED, TitledSeparator.TYPE_PARTIAL_LINE or TitledSeparator.TYPE_PARTIAL_GRADIENT_LINE.

textAlignment - Valid values are: SwingConstants.LEFT, SwingConstants.RIGHT, SwingConstants.LEADING or SwingConstants.TRAILING.

barAlignment - Valid values are: SwingConstants.TOP, SwingConstants.CENTER or SwingConstants.BOTTOM.

TitledSeparator

public TitledSeparator(JComponent labelComponent,
                       Border border,
                       int textAlignment,
                       int barAlignment)

Creates a titled separator with the specified component, border, alignment and vertical alignment. The alignment determines whether the specified component will lye on the right or left of the separator line. The vertical alignment refers to the alignment of the separator line -- top, middle or bottom.

Parameters:

labelComponent - the component to be used as the titled part of this separator

border - the border to be used as the separator line

textAlignment - Valid values are: SwingConstants.LEFT, SwingConstants.RIGHT, SwingConstants.LEADING or SwingConstants.TRAILING.

barAlignment - Valid values are: SwingConstants.TOP, SwingConstants.CENTER or SwingConstants.BOTTOM.

Method Detail

setLabelComponent

public void setLabelComponent(JComponent labelComponent)

Sets the labelComponent part of this Titled Separator.

Parameters:

labelComponent - the component holding the text to display as the title.

See Also:

getLabelComponent()

getLabelComponent

public JComponent getLabelComponent()

Returns the label part of this Titled Separator.

Returns:

the component holding the text to display as the title.

setSeparatorBorder

public void setSeparatorBorder(Border border)

Sets the border to be used as the graphical line region of this Titled Separator.

Parameters:

border - Any border of type: com.jidesoft.swing.PartialEtchedBorder, com.jidesoft.swing.PartialLineBorder or com.jidesoft.swing.PartialGradientLineBorder.

See Also:

getSeparatorBorder()

getSeparatorBorder

public Border getSeparatorBorder()

Returns the border type.

Returns:

the border type. Valid return values are: TitledSeparator.TYPE_PARTIAL_ETCHED, TitledSeparator.TYPE_PARTIAL_LINE, TitledSeparator.TYPE_PARTIAL_GRADIENT_LINE or -1 if the current border is none of the above.

setTextAlignment

public void setTextAlignment(int textAlignment)

Sets the texts horizontal alignment.

Parameters:

textAlignment - an int representing the texts horizontal position. Valid values are: SwingConstants.LEFT, SwingConstants.RIGHT, SwingConstants.LEADING or SwingConstants.TRAILING.

See Also:

getTextAlignment()

getTextAlignment

public int getTextAlignment()

Returns the texts horizontal alignment.

Returns:

the texts horizontal alignment. Valid return values are: SwingConstants.LEFT, SwingConstants.RIGHT, or SwingConstants.CENTER.

setBarAlignment

public void setBarAlignment(int barAlignment)

Sets the bars vertical alignment.

Parameters:

barAlignment - Valid values are: SwingConstants.TOP, SwingConstants.CENTER or SwingConstants.BOTTOM.

See Also:

getBarAlignment()

getBarAlignment

public int getBarAlignment()

Returns the bars vertical alignment.

Returns:

the barsverticall alignment. Valid values are: SwingConstants.TOP, SwingConstants.CENTER or SwingConstants.BOTTOM.

validateTitledSeparator

public void validateTitledSeparator()

Responsible for configurating this TitledSeparator. This is the method through which all constructors ultimately feed.

Creates a titled separator with the specified component, border, alignment and vertical alignment. The alignment determines whether the specified component will lye on the right or left of the separator line. The vertical alignment refers to the alignment of the separator line -- top, middle or bottom.