public class JXTitledSeparator extends JXPanel
A simple horizontal separator that contains a title.
JXTitledSeparator allows you to specify the title via the setTitle(java.lang.String)
method.
The title alignment may be specified by using the setHorizontalAlignment(int)
method, and accepts all the same arguments as the JLabel.setHorizontalAlignment(int)
method.
In addition, you may specify an Icon to use with this separator. The icon
will appear "leading" the title (on the left in left-to-right languages,
on the right in right-to-left languages). To change the position of the
title with respect to the icon, call setHorizontalTextPosition(int)
.
The default font and color of the title comes from the LookAndFeel
, mimicking
the font and color of the TitledBorder
Here are a few example code snippets:
//create a plain separator
JXTitledSeparator sep = new JXTitledSeparator();
sep.setTitle("Customer Info");
//create a separator with an icon
sep = new JXTitledSeparator();
sep.setTitle("Customer Info");
sep.setIcon(new ImageIcon("myimage.png"));
//create a separator with an icon to the right of the title,
//center justified
sep = new JXTitledSeparator();
sep.setTitle("Customer Info");
sep.setIcon(new ImageIcon("myimage.png"));
sep.setHorizontalAlignment(SwingConstants.CENTER);
sep.setHorizontalTextPosition(SwingConstants.TRAILING);
JPanel.AccessibleJPanel
JComponent.AccessibleJComponent
Container.AccessibleAWTContainer
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy
Modifier and Type | Field and Description |
---|---|
private JLabel |
label
Implementation detail: the label used to display the title
|
private JSeparator |
leftSeparator
Implementation detail: a separator to use on the left of the
title if alignment is centered or right justified
|
private JSeparator |
rightSeparator
Implementation detail: a separator to use on the right of the
title if alignment is centered or left justified
|
listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
Constructor and Description |
---|
JXTitledSeparator()
Creates a new instance of
JXTitledSeparator . |
JXTitledSeparator(String title)
Creates a new instance of
JXTitledSeparator with the specified
title. |
JXTitledSeparator(String title,
int horizontalAlignment)
Creates a new instance of
JXTitledSeparator with the specified
title and horizontal alignment. |
JXTitledSeparator(String title,
int horizontalAlignment,
Icon icon)
Creates a new instance of
JXTitledSeparator with the specified
title, icon, and horizontal alignment. |
Modifier and Type | Method and Description |
---|---|
ComponentOrientation |
getComponentOrientation() |
int |
getHorizontalAlignment()
Returns the alignment of the title contents along the X axis.
|
int |
getHorizontalTextPosition()
Returns the horizontal position of the title's text,
relative to the icon.
|
Icon |
getIcon()
Returns the graphic image (glyph, icon) that the
JXTitledSeparator displays. |
String |
getTitle()
Gets the title.
|
private void |
layoutSeparator()
Implementation detail. lays out this component, showing/hiding components
as necessary.
|
void |
setComponentOrientation(ComponentOrientation o) |
void |
setFont(Font font) |
void |
setForeground(Color foreground) |
void |
setHorizontalAlignment(int alignment)
Sets the alignment of the title along the X axis.
|
void |
setHorizontalTextPosition(int position)
Sets the horizontal position of the title's text,
relative to the icon.
|
void |
setIcon(Icon icon)
Defines the icon this component will display.
|
void |
setTitle(String title)
Sets the title for the separator.
|
protected void |
updateTitle()
Implementation detail.
|
getAlpha, getBackgroundPainter, getEffectiveAlpha, getPainterChangeListener, getPreferredScrollableViewportSize, getScrollableBlockIncrement, getScrollableHeightHint, getScrollableTracksViewportHeight, getScrollableTracksViewportWidth, getScrollableUnitIncrement, getScrollableWidthHint, installRepaintManager, isInheritAlpha, isPaintBorderInsets, paint, paintComponent, setAlpha, setBackground, setBackgroundPainter, setInheritAlpha, setPaintBorderInsets, setScrollableHeightHint, setScrollableTracksViewportHeight, setScrollableTracksViewportWidth, setScrollableWidthHint, uninstallRepaintManager
getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI
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, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paintBorder, paintChildren, 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, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
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, transferFocusDownCycle, validate, validateTree
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, 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, 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, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
private JSeparator leftSeparator
private JSeparator rightSeparator
public JXTitledSeparator()
JXTitledSeparator
. The default title is simply
an empty string. Default justification is LEADING
, and the default
horizontal text position is TRAILING
(title follows icon)public JXTitledSeparator(String title)
JXTitledSeparator
with the specified
title. Default horizontal alignment is LEADING
, and the default
horizontal text position is TRAILING
(title follows icon)public JXTitledSeparator(String title, int horizontalAlignment)
JXTitledSeparator
with the specified
title and horizontal alignment. The default
horizontal text position is TRAILING
(title follows icon)public JXTitledSeparator(String title, int horizontalAlignment, Icon icon)
JXTitledSeparator
with the specified
title, icon, and horizontal alignment. The default
horizontal text position is TRAILING
(title follows icon)protected void updateTitle()
private void layoutSeparator()
JXTitledSeparator
is treated as a single component rather than
a container.public void setTitle(String title)
title
- the new title. Any string input is acceptablepublic String getTitle()
JXTitledSeparator
.
This will be the raw title text, and so may include html tags etc
if they were so specified in #setTitle.public void setHorizontalAlignment(int alignment)
Sets the alignment of the title along the X axis. If leading, then the title will lead the separator (in left-to-right languages, the title will be to the left and the separator to the right). If centered, then a separator will be to the left, followed by the title (centered), followed by a separator to the right. Trailing will have the title on the right with a separator to its left, in left-to-right languages.
LEFT and RIGHT always position the text left or right of the separator, respectively, regardless of the language orientation.
alignment
- One of the following constants
defined in SwingConstants
:
LEFT
,
CENTER
,
RIGHT
,
LEADING
(the default) or
TRAILING
.IllegalArgumentException
- if the alignment does not match one of
the accepted inputs.SwingConstants
,
getHorizontalAlignment()
public int getHorizontalAlignment()
SwingConstants
:
LEFT
,
CENTER
,
RIGHT
,
LEADING
or
TRAILING
.setHorizontalAlignment(int)
,
SwingConstants
public void setHorizontalTextPosition(int position)
position
- One of the following constants
defined in SwingConstants
:
LEFT
,
CENTER
,
RIGHT
,
LEADING
, or
TRAILING
(the default).IllegalArgumentException
- if the position does not match one of
the accepted inputs.public int getHorizontalTextPosition()
SwingConstants
:
LEFT
,
CENTER
,
RIGHT
,
LEADING
or
TRAILING
.SwingConstants
public ComponentOrientation getComponentOrientation()
getComponentOrientation
in class Component
public void setComponentOrientation(ComponentOrientation o)
setComponentOrientation
in class Component
public void setIcon(Icon icon)
The default value of this property is null.
setHorizontalTextPosition(int)
,
getIcon()
public Icon getIcon()
JXTitledSeparator
displays.setIcon(javax.swing.Icon)
public void setForeground(Color foreground)
setForeground
in class JComponent
public void setFont(Font font)
setFont
in class JComponent
WebARTS Library Licensed Under the GNU - General Public License. Other Libraries licensed under their respective Open Source Licenses