Package org.jdesktop.swingx
Class JXTitledPanel
- java.lang.Object
-
- java.awt.Component
-
- java.awt.Container
-
- javax.swing.JComponent
-
- javax.swing.JPanel
-
- org.jdesktop.swingx.JXPanel
-
- org.jdesktop.swingx.JXTitledPanel
-
- All Implemented Interfaces:
ImageObserver,MenuContainer,Serializable,Accessible,Scrollable
public class JXTitledPanel extends JXPanel
A special type of Panel that has a Title section and a Content section.
The following properties can be set with the UIManager to change the look and feel of the JXTitledPanel:- JXTitledPanel.titleForeground
- JXTitledPanel.titleBackground
- JXTitledPanel.titleFont
- JXTitledPanel.titlePainter
- JXTitledPanel.captionInsets
- JXTitledPanel.rightDecorationInsets
- JXTitledPanel.leftDecorationInsets
- Author:
- Richard Bair, Nicola Ken Barozzi, Jeanette Winzenburg
- 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
Fields Modifier and Type Field Description static StringLEFT_DECORATIONstatic StringRIGHT_DECORATIONstatic StringuiClassID-
Fields inherited from class javax.swing.JComponent
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
accessibleContext, 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
Constructors Constructor Description JXTitledPanel()Create a new JTitledPanel with an empty string for the title.JXTitledPanel(String title)Create a new JTitledPanel with the given title as the title for the panel.JXTitledPanel(String title, Container content)Create a new JTitledPanel with the given String as the title, and the given Container as the content panel.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ContainergetContentContainer()JComponentgetLeftDecoration()JComponentgetRightDecoration()StringgetTitle()Gets the title for this titled panel.FontgetTitleFont()ColorgetTitleForeground()PaintergetTitlePainter()TitledPanelUIgetUI()Returns the look and feel (L&F) object that renders this component.StringgetUIClassID()Returns a string that specifies the name of the L&F class that renders this component.voidsetContentContainer(Container contentPanel)voidsetLeftDecoration(JComponent decoration)Adds the given JComponent as a decoration on the left of the titlevoidsetRightDecoration(JComponent decoration)Adds the given JComponent as a decoration on the right of the titlevoidsetTitle(String title)Sets the title for this title panel.voidsetTitleFont(Font titleFont)voidsetTitleForeground(Color titleForeground)voidsetTitlePainter(Painter p)Set the Painter to use for painting the title section of the JXTitledPanel.voidsetUI(TitledPanelUI ui)Sets the look and feel (L&F) object that renders this component.voidupdateUI()Notification from theUIManagerthat the L&F has changed.-
Methods inherited from class org.jdesktop.swingx.JXPanel
getAlpha, getBackgroundPainter, getEffectiveAlpha, getPainterChangeListener, getPreferredScrollableViewportSize, getScrollableBlockIncrement, getScrollableHeightHint, getScrollableTracksViewportHeight, getScrollableTracksViewportWidth, getScrollableUnitIncrement, getScrollableWidthHint, isInheritAlpha, isPaintBorderInsets, paint, paintComponent, setAlpha, setBackground, setBackgroundPainter, setInheritAlpha, setPaintBorderInsets, setScrollableHeightHint, setScrollableTracksViewportHeight, setScrollableTracksViewportWidth, setScrollableWidthHint
-
Methods inherited from class javax.swing.JPanel
getAccessibleContext, paramString, setUI
-
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, 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, 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, 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, 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, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
-
-
-
-
Field Detail
-
uiClassID
public static final String uiClassID
-
LEFT_DECORATION
public static final String LEFT_DECORATION
- See Also:
- Constant Field Values
-
RIGHT_DECORATION
public static final String RIGHT_DECORATION
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
JXTitledPanel
public JXTitledPanel()
Create a new JTitledPanel with an empty string for the title.
-
JXTitledPanel
public JXTitledPanel(String title)
Create a new JTitledPanel with the given title as the title for the panel.- Parameters:
title-
-
-
Method Detail
-
getUI
public TitledPanelUI getUI()
Returns the look and feel (L&F) object that renders this component.
-
setUI
public void setUI(TitledPanelUI ui)
Sets the look and feel (L&F) object that renders this component.- Parameters:
ui- the TitledPanelUI L&F object- See Also:
UIDefaults.getUI(javax.swing.JComponent)
-
getUIClassID
public String getUIClassID()
Returns a string that specifies the name of the L&F class that renders this component.- Overrides:
getUIClassIDin classJPanel- Returns:
- "TitledPanelUI"
- See Also:
JComponent.getUIClassID(),UIDefaults.getUI(javax.swing.JComponent)
-
updateUI
public void updateUI()
Notification from theUIManagerthat the L&F has changed. Replaces the current UI object with the latest version from theUIManager.- Overrides:
updateUIin classJPanel- See Also:
JComponent.updateUI()
-
getTitle
public String getTitle()
Gets the title for this titled panel.- Returns:
- the currently displayed title
-
setTitle
public void setTitle(String title)
Sets the title for this title panel.- Parameters:
title- the title to display
-
getContentContainer
public Container getContentContainer()
-
setContentContainer
public void setContentContainer(Container contentPanel)
-
setRightDecoration
public void setRightDecoration(JComponent decoration)
Adds the given JComponent as a decoration on the right of the title- Parameters:
decoration-
-
getRightDecoration
public JComponent getRightDecoration()
-
setLeftDecoration
public void setLeftDecoration(JComponent decoration)
Adds the given JComponent as a decoration on the left of the title- Parameters:
decoration-
-
getLeftDecoration
public JComponent getLeftDecoration()
-
getTitleFont
public Font getTitleFont()
-
setTitleFont
public void setTitleFont(Font titleFont)
-
setTitlePainter
public void setTitlePainter(Painter p)
Set the Painter to use for painting the title section of the JXTitledPanel. This value may be null, which will cause the current look and feel to paint an appropriate look- Parameters:
p- The Painter to use. May be null
-
getTitlePainter
public Painter getTitlePainter()
- Returns:
- the Painter to use for painting the background of the title section
-
getTitleForeground
public Color getTitleForeground()
-
setTitleForeground
public void setTitleForeground(Color titleForeground)
-
-