Package org.jfree.ui.tabbedui
Class AbstractTabbedUI
java.lang.Object
java.awt.Component
java.awt.Container
javax.swing.JComponent
org.jfree.ui.tabbedui.AbstractTabbedUI
- All Implemented Interfaces:
ImageObserver
,MenuContainer
,Serializable
A tabbed GUI. All views on the data are contained in tabs.
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprotected class
An exit action.private class
A tab change handler.private class
A tab enable change listener.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
FieldsModifier and TypeFieldDescriptionprivate Action
The close action assigned to this UI.private JComponent
The current toolbar.static final String
The global menu property.private boolean
Whether the UI should build a global menu from all root editors.private JMenuBar
The current menu bar.static final String
The menu bar property key.private ArrayList
The list of root editors.private int
The index of the currently selected root editor.private JTabbedPane
The tabbed pane filling the content area.private JPanel
The container component for the toolbar.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 -
Method Summary
Modifier and TypeMethodDescriptionprivate void
Adds menus.void
addRootEditor
(RootEditor rootPanel) Adds a root editor.protected abstract void
Attempts to exit.private void
Closes the toolbar.protected Action
Creates a close action.private JMenuBar
Creates a menu bar.Returns the close action.Returns the menu bar.protected abstract JMenu[]
The postfix menus.protected abstract JMenu[]
Returns the prefix menus.getRootEditor
(int pos) Returns the specified editor.int
Returns the number of root editors.int
Returns the selected editor.protected JTabbedPane
Returns the tabbed pane.boolean
Defines whether to use a global unified menu bar, which contains all menus from all tab-panes or whether to use local menubars.void
setGlobalMenu
(boolean globalMenu) Sets the global menu flag.protected void
setJMenuBar
(JMenuBar menuBar) Sets the menu bar.void
setSelectedEditor
(int selectedEditor) Sets the selected editor.private JMenuBar
Updates the global menu bar.protected void
updateRootEditorEnabled
(RootEditor editor) Update handler for the enable state of the root editor.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, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paramString, 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, updateUI
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, getAccessibleContext, 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, 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
-
Field Details
-
JMENUBAR_PROPERTY
The menu bar property key.- See Also:
-
GLOBAL_MENU_PROPERTY
The global menu property.- See Also:
-
rootEditors
The list of root editors. One for each tab. -
tabbedPane
The tabbed pane filling the content area. -
selectedRootEditor
private int selectedRootEditorThe index of the currently selected root editor. -
currentToolbar
The current toolbar. -
toolbarContainer
The container component for the toolbar. -
closeAction
The close action assigned to this UI. -
jMenuBar
The current menu bar. -
globalMenu
private boolean globalMenuWhether the UI should build a global menu from all root editors.
-
-
Constructor Details
-
AbstractTabbedUI
public AbstractTabbedUI()Default constructor.
-
-
Method Details
-
getTabbedPane
Returns the tabbed pane.- Returns:
- The tabbed pane.
-
isGlobalMenu
public boolean isGlobalMenu()Defines whether to use a global unified menu bar, which contains all menus from all tab-panes or whether to use local menubars.From an usability point of view, global menubars should be preferred, as this way users always see which menus are possibly available and do not wonder where the menus are disappearing.
- Returns:
- true, if global menus should be used, false otherwise.
-
setGlobalMenu
public void setGlobalMenu(boolean globalMenu) Sets the global menu flag.- Parameters:
globalMenu
- the flag.
-
getJMenuBar
Returns the menu bar.- Returns:
- The menu bar.
-
setJMenuBar
Sets the menu bar.- Parameters:
menuBar
- the menu bar.
-
createCloseAction
Creates a close action.- Returns:
- A close action.
-
getCloseAction
Returns the close action.- Returns:
- The close action.
-
getPrefixMenus
Returns the prefix menus.- Returns:
- The prefix menus.
-
getPostfixMenus
The postfix menus.- Returns:
- The postfix menus.
-
addMenus
Adds menus.- Parameters:
menuBar
- the menu barcustomMenus
- the menus that should be added.
-
updateGlobalMenubar
Updates the global menu bar.- Returns:
- the fully initialized menu bar.
-
createEditorMenubar
Creates a menu bar.- Parameters:
root
-- Returns:
- A menu bar.
-
addRootEditor
Adds a root editor.- Parameters:
rootPanel
- the root panel.
-
getRootEditorCount
public int getRootEditorCount()Returns the number of root editors.- Returns:
- The count.
-
getRootEditor
Returns the specified editor.- Parameters:
pos
- the position index.- Returns:
- The editor at the given position.
-
getSelectedEditor
public int getSelectedEditor()Returns the selected editor.- Returns:
- The selected editor.
-
setSelectedEditor
public void setSelectedEditor(int selectedEditor) Sets the selected editor.- Parameters:
selectedEditor
- the selected editor.
-
closeToolbar
private void closeToolbar()Closes the toolbar. -
attempExit
protected abstract void attempExit()Attempts to exit. -
updateRootEditorEnabled
Update handler for the enable state of the root editor.- Parameters:
editor
- the editor.
-