org.jvnet.substance.utils
public class SubstanceTitlePane extends javax.swing.JComponent
Modifier and Type | Class and Description |
---|---|
protected static class |
SubstanceTitlePane.ExtraComponentKind
Enumerates the types of children components.
|
static class |
SubstanceTitlePane.HeapStatusPanel
Panel that shows heap status and allows running the garbage collector.
|
static class |
SubstanceTitlePane.HeapStatusThread
Thread for heap status panel.
|
class |
SubstanceTitlePane.SubstanceMenuBar
Class responsible for drawing the system menu.
|
protected class |
SubstanceTitlePane.TitlePaneLayout
Layout manager for the title pane.
|
javax.swing.JComponent.AccessibleJComponent
Modifier and Type | Field and Description |
---|---|
protected java.awt.Image |
appIcon
The application icon to be displayed.
|
protected javax.swing.JButton |
closeButton
Button used to close the frame.
|
protected static java.lang.String |
EXTRA_COMPONENT_KIND
Client property to mark every child to be either leading or trailing.
|
protected javax.swing.JCheckBoxMenuItem |
heapStatusMenuItem
The heap status toggle menu item of
this title pane. |
protected SubstanceTitlePane.HeapStatusPanel |
heapStatusPanel
The heap status panel of
this title pane. |
protected javax.swing.JMenuBar |
menuBar
JMenuBar, typically renders the system menu items.
|
protected javax.swing.JButton |
minimizeButton
Button used to minimize the frame
|
protected java.beans.PropertyChangeListener |
propertyListener
Listens on changes to
componentOrientation and
SubstanceLookAndFeel.WINDOW_MODIFIED properties. |
protected javax.swing.JRootPane |
rootPane
JRootPane rendering for.
|
protected javax.swing.JButton |
toggleButton
Button used to maximize or restore the frame.
|
protected java.awt.Window |
window
Window we're currently in.
|
accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
Constructor and Description |
---|
SubstanceTitlePane(javax.swing.JRootPane root,
SubstanceRootPaneUI ui)
Creates a new title pane.
|
Modifier and Type | Method and Description |
---|---|
void |
addNotify() |
protected java.awt.LayoutManager |
createLayout()
Returns the
LayoutManager that should be installed on the
SubstanceTitlePane . |
protected javax.swing.JMenuBar |
createMenuBar()
Returns the
JMenuBar displaying the appropriate system menu
items. |
javax.swing.JRootPane |
getRootPane()
Returns the
JRootPane this was created for. |
protected java.awt.Rectangle |
getTitleTextRectangle()
Computes the rectangle of the title text.
|
protected int |
getWindowDecorationStyle()
Returns the decoration style of the
JRootPane . |
protected void |
markExtraComponent(javax.swing.JComponent comp,
SubstanceTitlePane.ExtraComponentKind kind)
Marks the specified child component with the specified extra component
kind.
|
void |
paintComponent(java.awt.Graphics g) |
void |
removeNotify() |
static void |
setHeapStatusLogfileName(java.lang.String heapStatusLogfileName)
Sets location for heap status logfile.
|
protected void |
syncCloseButtonTooltip()
Synchronizes the tooltip of the close button.
|
void |
uninstall()
Uninstalls the necessary state.
|
addAncestorListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getAccessibleContext, 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, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, 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, updateUI
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, 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, transferFocusBackward, transferFocusUpCycle
protected javax.swing.JMenuBar menuBar
protected javax.swing.JButton toggleButton
protected javax.swing.JButton minimizeButton
protected javax.swing.JButton closeButton
protected java.awt.Window window
protected javax.swing.JRootPane rootPane
protected SubstanceTitlePane.HeapStatusPanel heapStatusPanel
this
title pane.protected javax.swing.JCheckBoxMenuItem heapStatusMenuItem
this
title pane.protected java.beans.PropertyChangeListener propertyListener
componentOrientation
and
SubstanceLookAndFeel.WINDOW_MODIFIED
properties.protected static final java.lang.String EXTRA_COMPONENT_KIND
SubstanceTitlePane.ExtraComponentKind
.protected java.awt.Image appIcon
public SubstanceTitlePane(javax.swing.JRootPane root, SubstanceRootPaneUI ui)
root
- Root pane.ui
- Root pane UI.public void uninstall()
public javax.swing.JRootPane getRootPane()
JRootPane
this was created for.getRootPane
in class javax.swing.JComponent
protected int getWindowDecorationStyle()
JRootPane
.JRootPane
.public void addNotify()
addNotify
in class javax.swing.JComponent
public void removeNotify()
removeNotify
in class javax.swing.JComponent
protected javax.swing.JMenuBar createMenuBar()
JMenuBar
displaying the appropriate system menu
items.JMenuBar
displaying the appropriate system menu
items.protected java.awt.LayoutManager createLayout()
LayoutManager
that should be installed on the
SubstanceTitlePane
.public void paintComponent(java.awt.Graphics g)
paintComponent
in class javax.swing.JComponent
protected java.awt.Rectangle getTitleTextRectangle()
EXTRA_COMPONENT_KIND
client property). The
title text rectangle is the space between the leading group and the
trailing group.java.lang.IllegalStateException
- If at least one child component of this title pane is not
marked with the EXTRA_COMPONENT_KIND
client
property.markExtraComponent(JComponent, ExtraComponentKind)
,
EXTRA_COMPONENT_KIND
public static void setHeapStatusLogfileName(java.lang.String heapStatusLogfileName)
#setCanHaveHeapStatusPanel(boolean)
was called with
true
.heapStatusLogfileName
- Logfile for the heap status panel.protected void syncCloseButtonTooltip()
protected void markExtraComponent(javax.swing.JComponent comp, SubstanceTitlePane.ExtraComponentKind kind)
comp
- Child component.kind
- Extra kind.getTitleTextRectangle()
,
EXTRA_COMPONENT_KIND