public class JRibbonFrame
extends javax.swing.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 inteferes with the intended hierarchy of this frame.
java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
java.awt.Container.AccessibleAWTContainer
Modifier and Type | Field | Description |
---|---|---|
protected java.util.concurrent.ExecutorService |
setAppIconExecutor |
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
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
Constructor | Description |
---|---|
JRibbonFrame() |
Creates a new ribbon frame with no title.
|
JRibbonFrame(java.awt.GraphicsConfiguration gc) |
Creates a new ribbon frame with no title.
|
JRibbonFrame(java.lang.String title) |
Creates a new ribbon frame with the specified title.
|
JRibbonFrame(java.lang.String title,
java.awt.GraphicsConfiguration gc) |
Creates a new ribbon frame with the specified title.
|
Modifier and Type | Method | Description |
---|---|---|
protected javax.swing.JRootPane |
createRootPane() |
|
void |
dispose() |
|
ResizableIcon |
getApplicationIcon() |
|
JRibbon |
getRibbon() |
Returns the ribbon component.
|
boolean |
isShowingKeyTips() |
Returns indication whether this ribbon frame is showing the key tips.
|
void |
setApplicationIcon(ResizableIcon icon) |
|
void |
setContentPane(java.awt.Container contentPane) |
|
void |
setIconImages(java.util.List<? extends java.awt.Image> icons) |
|
void |
setJMenuBar(javax.swing.JMenuBar menubar) |
|
void |
setLayout(java.awt.LayoutManager manager) |
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
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
addNotify, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setBackground, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setOpacity, setResizable, setShape, setState, setTitle, setUndecorated
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
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
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, hide, 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, show, toBack, toFront
public JRibbonFrame() throws java.awt.HeadlessException
java.awt.HeadlessException
- If GraphicsEnvironment.isHeadless() returns true.public JRibbonFrame(java.awt.GraphicsConfiguration gc)
gc
- Graphics configuration to use.public JRibbonFrame(java.lang.String title) throws java.awt.HeadlessException
title
- Ribbon frame title.java.awt.HeadlessException
- If GraphicsEnvironment.isHeadless() returns true.public JRibbonFrame(java.lang.String title, java.awt.GraphicsConfiguration gc)
title
- Ribbon frame title.gc
- Graphics configuration to use.java.awt.HeadlessException
- If GraphicsEnvironment.isHeadless() returns true.public void dispose()
dispose
in class java.awt.Window
public void setLayout(java.awt.LayoutManager manager)
setLayout
in class javax.swing.JFrame
public void setJMenuBar(javax.swing.JMenuBar menubar)
setJMenuBar
in class javax.swing.JFrame
public void setContentPane(java.awt.Container contentPane)
setContentPane
in class javax.swing.JFrame
public JRibbon getRibbon()
protected javax.swing.JRootPane createRootPane()
createRootPane
in class javax.swing.JFrame
public void setIconImages(java.util.List<? extends java.awt.Image> icons)
setIconImages
in class java.awt.Window
public void setApplicationIcon(ResizableIcon icon)
public ResizableIcon getApplicationIcon()
public boolean isShowingKeyTips()
true
if this ribbon frame is showing the key tips,
false
otherwise.