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

public class JRibbonFrame
extends JFrame

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.

Author:

Kirill Grouchnikov

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JRibbonFrame.GlobalPopupMenuPanel
static class	JRibbonFrame.RibbonKeyboardAction

Nested classes/interfaces inherited from class JFrame

JFrame.AccessibleJFrame

Nested classes/interfaces inherited from class Frame

Frame.AccessibleAWTFrame

Nested classes/interfaces inherited from class Window

Window.AccessibleAWTWindow, Window.Type

Nested classes/interfaces inherited from class Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields inherited from class JFrame

accessibleContext, rootPane, rootPaneCheckingEnabled

Fields inherited from class 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 Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Fields inherited from interface WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE

Constructor Summary

Constructors

Constructor	Description
JRibbonFrame()	Creates a new ribbon frame with no title.
JRibbonFrame(GraphicsConfiguration gc)	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 Type	Method	Description
protected JRootPane	createRootPane()
void	dispose()
JRibbon	getRibbon()	Returns the ribbon component.
void	hide()
boolean	isShowingKeyTips()	Returns indication whether this ribbon frame is showing the key tips.
void	setApplicationIcon(RadianceIcon.Factory iconFactory)
void	setContentPane(Container contentPane)
void	setIconImages(List<? extends Image> icons)
void	setJMenuBar(JMenuBar menubar)
void	setKeyboardActions(Set<JRibbonFrame.RibbonKeyboardAction> actions)
void	setLayout(LayoutManager manager)
void	show()

Methods inherited from class 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 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 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 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 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 Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface MenuContainer

getFont, postEvent

Constructor Details

JRibbonFrame

public JRibbonFrame()
             throws HeadlessException

Creates a new ribbon frame with no title.

Throws:

HeadlessException - If GraphicsEnvironment.isHeadless() returns true.

JRibbonFrame

public JRibbonFrame(GraphicsConfiguration gc)

Creates a new ribbon frame with no title.

Parameters:

gc - Graphics configuration to use.

JRibbonFrame

public JRibbonFrame(String title)
             throws HeadlessException

Creates a new ribbon frame with the specified title.

Parameters:

title - Ribbon frame title.

Throws:

HeadlessException - If GraphicsEnvironment.isHeadless() returns true.

JRibbonFrame

public JRibbonFrame(String title,
 GraphicsConfiguration gc)

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

public void setLayout(LayoutManager manager)

Overrides:

setLayout in class JFrame

setJMenuBar

public void setJMenuBar(JMenuBar menubar)

Overrides:

setJMenuBar in class JFrame

setContentPane

public void setContentPane(Container contentPane)

Specified by:

setContentPane in interface RootPaneContainer

Overrides:

setContentPane in class JFrame

dispose

public void dispose()

Overrides:

dispose in class Window

show

public void show()

Overrides:

show in class Window

hide

public void hide()

Overrides:

hide in class Window

getRibbon

public JRibbon getRibbon()

Returns the ribbon component.

Returns:

Ribbon component.

createRootPane

protected JRootPane createRootPane()

Overrides:

createRootPane in class JFrame

setKeyboardActions

public void setKeyboardActions(Set<JRibbonFrame.RibbonKeyboardAction> actions)

setIconImages

public void setIconImages(List<? extends Image> icons)

Overrides:

setIconImages in class Window

setApplicationIcon

public void setApplicationIcon(RadianceIcon.Factory iconFactory)

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.