Class JRibbonFrame
java.lang.Object
java.awt.Component
java.awt.Container
java.awt.Window
java.awt.Frame
javax.swing.JFrame
org.pushingpixels.radiance.component.api.ribbon.JRibbonFrame
- All Implemented Interfaces:
ImageObserver
,MenuContainer
,Serializable
,Accessible
,RootPaneContainer
,WindowConstants
Ribbon frame. Provides the same functionality as a regular JFrame
, but with a
JRibbon
component in the top location.
This is the only officially supported way to use the JRibbon
container. While
JRibbon()
constructor is public, it is provided only for the applications that
are absolutely prevented from using JRibbonFrame
class.
The implementation enforces that a JRibbon
component is always at the
BorderLayout.NORTH
location, throwing IllegalArgumentException
on attempts to set
a custom layout manager, add another component at BorderLayout.NORTH
, remove the
JRibbon
component, set a custom menu bar, content pane or any other operation that
interferes with the intended hierarchy of this frame.
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
private static class
A custom layer that shows the currently visible key tip chain.private static class
Custom layout manager that enforces theJRibbon
location atBorderLayout.NORTH
.static class
Nested classes/interfaces inherited from class javax.swing.JFrame
JFrame.AccessibleJFrame
Nested classes/interfaces inherited from class java.awt.Frame
Frame.AccessibleAWTFrame
Nested classes/interfaces inherited from class java.awt.Window
Window.AccessibleAWTWindow, Window.Type
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 AWTEventListener
private KeyTipManager.KeyTipListener
private JRibbon
The ribbon component.private boolean
Fields inherited from class javax.swing.JFrame
accessibleContext, rootPane, rootPaneCheckingEnabled
Fields inherited from class java.awt.Frame
CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR
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
Fields inherited from interface javax.swing.WindowConstants
DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE
-
Constructor Summary
ConstructorsConstructorDescriptionCreates a new ribbon frame with no title.Creates a new ribbon frame with no title.JRibbonFrame
(String title) Creates a new ribbon frame with the specified title.JRibbonFrame
(String title, GraphicsConfiguration gc) Creates a new ribbon frame with the specified title. -
Method Summary
Modifier and TypeMethodDescriptionprotected JRootPane
void
dispose()
private List
<RibbonTask> private static Image
getImage
(RadianceIcon.Factory iconFactory, int size) private RibbonTask
private RibbonTask
Returns the ribbon component.private void
handlePopupTrigger
(MouseEvent event, Component c) void
hide()
private void
Initializes the layout and the ribbon.private boolean
boolean
Returns indication whether this ribbon frame is showing the key tips.private boolean
private void
setApplicationAndMenuButtonIcon
(RadianceIcon.Factory iconFactory) void
setApplicationIcon
(RadianceIcon.Factory iconFactory) void
setContentPane
(Container contentPane) void
setIconImages
(List<? extends Image> icons) void
setJMenuBar
(JMenuBar menubar) void
void
setLayout
(LayoutManager manager) private void
setLegacyIconImages
(List<Image> images) void
show()
Methods inherited from class javax.swing.JFrame
addImpl, frameInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setIconImage, setLayeredPane, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update
Methods inherited from class java.awt.Frame
addNotify, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setBackground, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setOpacity, setResizable, setShape, setState, setTitle, setUndecorated
Methods inherited from class java.awt.Window
addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, setVisible, toBack, toFront
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, 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, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setMixingCutoutShape, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface java.awt.MenuContainer
getFont, postEvent
-
Field Details
-
ribbon
The ribbon component. -
wasSetIconImagesCalled
private boolean wasSetIconImagesCalled -
awtEventListener
-
keyTipListener
-
-
Constructor Details
-
JRibbonFrame
Creates a new ribbon frame with no title.- Throws:
HeadlessException
- If GraphicsEnvironment.isHeadless() returns true.
-
JRibbonFrame
Creates a new ribbon frame with no title.- Parameters:
gc
- Graphics configuration to use.
-
JRibbonFrame
Creates a new ribbon frame with the specified title.- Parameters:
title
- Ribbon frame title.- Throws:
HeadlessException
- If GraphicsEnvironment.isHeadless() returns true.
-
JRibbonFrame
Creates a new ribbon frame with the specified title.- Parameters:
title
- Ribbon frame title.gc
- Graphics configuration to use.- Throws:
HeadlessException
- If GraphicsEnvironment.isHeadless() returns true.
-
-
Method Details
-
setLayout
-
setJMenuBar
- Overrides:
setJMenuBar
in classJFrame
-
setContentPane
- Specified by:
setContentPane
in interfaceRootPaneContainer
- Overrides:
setContentPane
in classJFrame
-
initRibbon
private void initRibbon()Initializes the layout and the ribbon. -
dispose
public void dispose() -
show
public void show() -
hide
public void hide() -
isValidPopupTriggerSource
-
isInTaskbar
-
handlePopupTrigger
-
getRibbon
Returns the ribbon component.- Returns:
- Ribbon component.
-
createRootPane
- Overrides:
createRootPane
in classJFrame
-
setKeyboardActions
-
setIconImages
- Overrides:
setIconImages
in classWindow
-
setApplicationIcon
-
setApplicationAndMenuButtonIcon
-
setLegacyIconImages
-
getImage
-
isShowingKeyTips
public boolean isShowingKeyTips()Returns indication whether this ribbon frame is showing the key tips.- Returns:
true
if this ribbon frame is showing the key tips,false
otherwise.
-
getAllShownRibbonTasks
-
getNextRibbonTask
-
getPreviousRibbonTask
-