Class JRibbon
- java.lang.Object
-
- java.awt.Component
-
- java.awt.Container
-
- javax.swing.JComponent
-
- org.pushingpixels.radiance.component.api.ribbon.JRibbon
-
- All Implemented Interfaces:
java.awt.image.ImageObserver
,java.awt.MenuContainer
,java.io.Serializable
public class JRibbon extends javax.swing.JComponent
The ribbon component.The ribbon has the following major parts:
- Ribbon tasks added with
addTask(RibbonTask)
- Contextual ribbon task groups added with
addContextualTaskGroup(RibbonContextualTaskGroup)
- Application menu content set by
setApplicationMenuCommand(RibbonApplicationMenuCommandButtonProjection)
- Taskbar panel populated by
addTaskbarCommand(BaseCommandButtonProjection)
,addTaskbarGalleryDropdown(RibbonGalleryProjection)
andaddTaskbarComponent(ComponentProjection)
- Anchored content set by
addAnchoredCommand(CommandButtonProjection)
While multiple ribbon tasks can be added to the ribbon, only one is visible at any given time. This task is called the selected task. Tasks can be switched with the task buttons placed along the top part of the ribbon. Once a task has been added to the ribbon, it cannot be removed.
The contextual ribbon task groups allow showing and hiding ribbon tasks based on the current selection in the application. For example, Word only shows the table tasks when a table is selected in the document. By default, tasks belonging to the groups added by
addContextualTaskGroup(RibbonContextualTaskGroup)
are not visible. To show the tasks belonging to the specific group, callsetVisible(RibbonContextualTaskGroup, boolean)
API. Note that you can have multiple task groups visible at the same time.The application menu button is a rectangular button shown in the top left corner of the ribbon. If the
setApplicationMenuCommand(RibbonApplicationMenuCommandButtonProjection)
is not called, or called with thenull
value, the application menu button is not shown, and ribbon task buttons are shifted to the left.The taskbar panel allows showing controls that are visible no matter what ribbon task is selected. To add content to taskbar, use the
addTaskbarCommand(BaseCommandButtonProjection)
,addTaskbarGalleryDropdown(RibbonGalleryProjection)
andaddTaskbarComponent(ComponentProjection)
APIs. The taskbar panel lives in the top-left corner of the application frame.The ribbon can be minimized in one of the following ways:
- Calling
setMinimized(boolean)
withtrue
. - User double-clicking on a task button.
- User pressing
Meta+Alt+R
key combination on a Mac machine orCtrl+F1
key combination on a non-Mac machine.
A minimized ribbon shows the application menu button, taskbar panel, task buttons and anchored contet, but not the ribbon bands of the selected task. Clicking a task button shows the ribbon bands of that task in a popup without shifting the application content down.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
JRibbon.OnShowContextualMenuListener
static interface
JRibbon.OnTaskSelectionChangeListener
private class
JRibbon.TaskbarAppMenuLinkHandler
private class
JRibbon.TaskbarCommandHandler<M extends BaseCommand<MCM>,MCM extends BaseCommandMenuContentModel,P extends BaseCommandButtonPresentationModel<MPM,P>,MPM extends BaseCommandPopupMenuPresentationModel>
private class
JRibbon.TaskbarComponentHandler<C extends javax.swing.JComponent,CCM extends ComponentContentModel>
private static interface
JRibbon.TaskbarContentHandler<T extends ContentModel>
private class
JRibbon.TaskbarGalleryDropdownHandler
-
Nested classes/interfaces inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
-
-
Field Summary
Fields Modifier and Type Field Description private java.util.ArrayList<CommandButtonProjection>
anchoredCommands
Commands anchored to the far edge of the task toggle strip (right under LTR and left under RTL).private RibbonApplicationMenuCommandButtonProjection
applicationMenuCommandProjection
private RibbonApplicationMenuProjection
applicationMenuProjection
The application menu.private java.util.ArrayList<AbstractRibbonBand>
bands
Bands of the currently shown task.private java.util.ArrayList<RibbonContextualTaskGroup>
contextualTaskGroups
The contextual task groups.private RibbonTask
currentlySelectedTask
Currently selected (shown) task.private java.util.Map<RibbonContextualTaskGroup,java.lang.Boolean>
groupVisibilityMap
Visibility status of the contextual task group.private boolean
isMinimized
Indicates whether the ribbon is currently minimized.private JRibbon.OnShowContextualMenuListener
onShowContextualMenuListener
private java.util.List<JRibbon.OnTaskSelectionChangeListener>
onTaskSelectionChangeListeners
private JRibbonFrame
ribbonFrame
The host ribbon frame.private java.util.ArrayList<java.awt.Component>
taskbarComponents
The taskbar components (displayed between the application menu button and the frame title).private java.util.List<JRibbon.TaskbarContentHandler<?>>
taskbarContentHandlers
private RibbonTaskbarKeyTipPolicy
taskbarKeyTipPolicy
private java.util.ArrayList<RibbonTask>
tasks
The general tasks.static java.lang.String
uiClassID
The UI class ID string.-
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
-
-
Constructor Summary
Constructors Constructor Description JRibbon()
Creates a new empty ribbon.JRibbon(JRibbonFrame ribbonFrame)
Creates an empty ribbon for the specified ribbon frame.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addAnchoredCommand(CommandButtonProjection projection)
Adds the specified ribbon command projection to the trailing edge of the task toggle strip of this ribbon.void
addChangeListener(javax.swing.event.ChangeListener l)
Adds the specified change listener to track changes to this ribbon.void
addContextualTaskGroup(RibbonContextualTaskGroup group)
Adds the specified contextual task group to this ribbon.void
addOnTaskSelectionChangedListener(JRibbon.OnTaskSelectionChangeListener listener)
void
addTask(RibbonTask task)
Adds the specified task to this ribbon.void
addTaskbarAppMenuLink(Command appMenuCommand)
<M extends BaseCommand<MCM>,MCM extends BaseCommandMenuContentModel,P extends BaseCommandButtonPresentationModel<MPM,P>,MPM extends BaseCommandPopupMenuPresentationModel>
voidaddTaskbarCommand(BaseCommandButtonProjection<M,MCM,P,MPM> projection)
void
addTaskbarComponent(ComponentProjection<? extends javax.swing.JComponent,? extends ComponentContentModel> projection)
void
addTaskbarGalleryDropdown(RibbonGalleryProjection galleryProjection)
void
clearTaskbar()
Removes all taskbar content from this ribbon.protected void
fireStateChanged()
Notifies all registered listeners that the state of this ribbon has changed.private void
fireTaskSelectionChanged()
java.util.List<CommandButtonProjection>
getAnchoredCommands()
Returns the anchored commands for this ribbon.RibbonApplicationMenuCommandButtonProjection
getApplicationMenuCommandProjection()
RibbonApplicationMenuProjection
getApplicationMenuProjection()
Returns the application menu of this ribbon.RibbonContextualTaskGroup
getContextualTaskGroup(int index)
Retrieves contextual task group at specified index.int
getContextualTaskGroupCount()
Returns the number of contextual task groups inthis
ribbon.JRibbon.OnShowContextualMenuListener
getOnShowContextualMenuListener()
JRibbonFrame
getRibbonFrame()
Returns the ribbon frame that hosts this ribbon.RibbonTask
getSelectedTask()
Returns the currently selected task.RibbonTask
getTask(int index)
Retrieves the regular task at specified index.java.util.List<java.awt.Component>
getTaskbarComponents()
private JRibbon.TaskbarContentHandler
getTaskbarContentHandlerFor(ContentModel key)
RibbonTaskbarKeyTipPolicy
getTaskbarKeyTipPolicy()
int
getTaskCount()
Returns the number of regular tasks inthis
ribbon.RibbonUI
getUI()
Returns the UI delegate for this component.java.lang.String
getUIClassID()
boolean
isMinimized()
Returns the indication whether this ribbon is minimized.boolean
isShowingInTaskbar(BaseCommand<?> command)
boolean
isShowingInTaskbar(RibbonGalleryContentModel galleryContentModel)
boolean
isShowingInTaskbar(ComponentContentModel componentContentModel)
boolean
isVisible(RibbonContextualTaskGroup group)
Returns the visibility of ribbon tasks in the specified contextual task group.private boolean
matchesTaskbarContentHandler(ContentModel key)
void
removeAnchoredCommand(CommandButtonProjection projection)
Removes the specified ribbon command from the trailing edge of the task toggle strip of this ribbon.void
removeChangeListener(javax.swing.event.ChangeListener l)
Removes the specified change listener from tracking changes to this ribbon.void
removeOnTaskSelectionChangedListener(JRibbon.OnTaskSelectionChangeListener listener)
void
removeTaskbarAppMenuLink(Command appMenuCommand)
void
removeTaskbarCommand(BaseCommand<?> command)
void
removeTaskbarComponent(ComponentContentModel componentContentModel)
private void
removeTaskbarContentHandlerFor(ContentModel key)
void
removeTaskbarGallery(RibbonGalleryContentModel galleryContentModel)
void
setApplicationMenuCommand(RibbonApplicationMenuCommandButtonProjection applicationMenuCommandProjection)
Sets the application menu command for this ribbon.void
setMinimized(boolean isMinimized)
Changes the minimized state of this ribbon.void
setOnShowContextualMenuListener(JRibbon.OnShowContextualMenuListener onShowContextualMenuListener)
void
setSelectedTask(RibbonTask task)
Selects the specified task.void
setTaskbarKeyTipPolicy(RibbonTaskbarKeyTipPolicy taskbarKeyTipPolicy)
void
setVisible(boolean flag)
void
setVisible(RibbonContextualTaskGroup group, boolean isVisible)
Sets the visibility of ribbon tasks in the specified contextual task group.private void
syncTaskbarContent()
void
updateUI()
-
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, 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, unregisterKeyboardAction, update
-
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, 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, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
-
-
-
-
Field Detail
-
tasks
private java.util.ArrayList<RibbonTask> tasks
The general tasks.- See Also:
addTask(RibbonTask)
,getTaskCount()
,getTask(int)
-
contextualTaskGroups
private java.util.ArrayList<RibbonContextualTaskGroup> contextualTaskGroups
The contextual task groups.
-
taskbarComponents
private java.util.ArrayList<java.awt.Component> taskbarComponents
The taskbar components (displayed between the application menu button and the frame title).
-
taskbarContentHandlers
private java.util.List<JRibbon.TaskbarContentHandler<?>> taskbarContentHandlers
-
bands
private java.util.ArrayList<AbstractRibbonBand> bands
Bands of the currently shown task.
-
currentlySelectedTask
private RibbonTask currentlySelectedTask
Currently selected (shown) task.
-
anchoredCommands
private java.util.ArrayList<CommandButtonProjection> anchoredCommands
Commands anchored to the far edge of the task toggle strip (right under LTR and left under RTL).
-
groupVisibilityMap
private java.util.Map<RibbonContextualTaskGroup,java.lang.Boolean> groupVisibilityMap
Visibility status of the contextual task group. Must contain a value for each group incontextualTaskGroups
.
-
applicationMenuCommandProjection
private RibbonApplicationMenuCommandButtonProjection applicationMenuCommandProjection
-
applicationMenuProjection
private RibbonApplicationMenuProjection applicationMenuProjection
The application menu.
-
isMinimized
private boolean isMinimized
Indicates whether the ribbon is currently minimized.- See Also:
setMinimized(boolean)
,isMinimized()
-
ribbonFrame
private JRibbonFrame ribbonFrame
The host ribbon frame. Isnull
when the ribbon is not hosted in aJRibbonFrame
.
-
onShowContextualMenuListener
private JRibbon.OnShowContextualMenuListener onShowContextualMenuListener
-
onTaskSelectionChangeListeners
private java.util.List<JRibbon.OnTaskSelectionChangeListener> onTaskSelectionChangeListeners
-
taskbarKeyTipPolicy
private RibbonTaskbarKeyTipPolicy taskbarKeyTipPolicy
-
uiClassID
public static final java.lang.String uiClassID
The UI class ID string.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
JRibbon
public JRibbon()
Creates a new empty ribbon. Applications are highly encouraged to useJRibbonFrame
and access the ribbon withJRibbonFrame.getRibbon()
API.
-
JRibbon
JRibbon(JRibbonFrame ribbonFrame)
Creates an empty ribbon for the specified ribbon frame.- Parameters:
ribbonFrame
- Host ribbon frame.
-
-
Method Detail
-
setTaskbarKeyTipPolicy
public void setTaskbarKeyTipPolicy(RibbonTaskbarKeyTipPolicy taskbarKeyTipPolicy)
-
getTaskbarKeyTipPolicy
public RibbonTaskbarKeyTipPolicy getTaskbarKeyTipPolicy()
-
matchesTaskbarContentHandler
private boolean matchesTaskbarContentHandler(ContentModel key)
-
getTaskbarContentHandlerFor
private JRibbon.TaskbarContentHandler getTaskbarContentHandlerFor(ContentModel key)
-
removeTaskbarContentHandlerFor
private void removeTaskbarContentHandlerFor(ContentModel key)
-
syncTaskbarContent
private void syncTaskbarContent()
-
addTaskbarCommand
public <M extends BaseCommand<MCM>,MCM extends BaseCommandMenuContentModel,P extends BaseCommandButtonPresentationModel<MPM,P>,MPM extends BaseCommandPopupMenuPresentationModel> void addTaskbarCommand(BaseCommandButtonProjection<M,MCM,P,MPM> projection)
-
isShowingInTaskbar
public boolean isShowingInTaskbar(BaseCommand<?> command)
-
removeTaskbarCommand
public void removeTaskbarCommand(BaseCommand<?> command)
-
addTaskbarAppMenuLink
public void addTaskbarAppMenuLink(Command appMenuCommand)
-
removeTaskbarAppMenuLink
public void removeTaskbarAppMenuLink(Command appMenuCommand)
-
addTaskbarComponent
public void addTaskbarComponent(ComponentProjection<? extends javax.swing.JComponent,? extends ComponentContentModel> projection)
-
isShowingInTaskbar
public boolean isShowingInTaskbar(ComponentContentModel componentContentModel)
-
removeTaskbarComponent
public void removeTaskbarComponent(ComponentContentModel componentContentModel)
-
addTaskbarGalleryDropdown
public void addTaskbarGalleryDropdown(RibbonGalleryProjection galleryProjection)
-
isShowingInTaskbar
public boolean isShowingInTaskbar(RibbonGalleryContentModel galleryContentModel)
-
removeTaskbarGallery
public void removeTaskbarGallery(RibbonGalleryContentModel galleryContentModel)
-
clearTaskbar
public void clearTaskbar()
Removes all taskbar content from this ribbon.
-
addTask
public void addTask(RibbonTask task)
Adds the specified task to this ribbon.- Parameters:
task
- The ribbon task to add.- See Also:
addContextualTaskGroup(RibbonContextualTaskGroup)
,getTaskCount()
,getTask(int)
-
addAnchoredCommand
public void addAnchoredCommand(CommandButtonProjection projection)
Adds the specified ribbon command projection to the trailing edge of the task toggle strip of this ribbon.- Parameters:
projection
- Command projection to add.- See Also:
getAnchoredCommands()
,removeAnchoredCommand(CommandButtonProjection)
-
removeAnchoredCommand
public void removeAnchoredCommand(CommandButtonProjection projection)
Removes the specified ribbon command from the trailing edge of the task toggle strip of this ribbon.- Parameters:
projection
- Command projection to remove.- See Also:
getAnchoredCommands()
,addAnchoredCommand(CommandButtonProjection)
-
getAnchoredCommands
public java.util.List<CommandButtonProjection> getAnchoredCommands()
Returns the anchored commands for this ribbon.- Returns:
- This ribbon's anchored commands.
- See Also:
addAnchoredCommand(CommandButtonProjection)
,removeAnchoredCommand(CommandButtonProjection)
-
addContextualTaskGroup
public void addContextualTaskGroup(RibbonContextualTaskGroup group)
Adds the specified contextual task group to this ribbon.- Parameters:
group
- Task group to add.- See Also:
addTask(RibbonTask)
,setVisible(RibbonContextualTaskGroup, boolean)
,isVisible(RibbonContextualTaskGroup)
-
getTaskCount
public int getTaskCount()
Returns the number of regular tasks inthis
ribbon.- Returns:
- Number of regular tasks in
this
ribbon. - See Also:
getTask(int)
,addTask(RibbonTask)
-
getTask
public RibbonTask getTask(int index)
Retrieves the regular task at specified index.- Parameters:
index
- Task index.- Returns:
- Task that matches the specified index.
- See Also:
getTaskCount()
,addTask(RibbonTask)
-
getContextualTaskGroupCount
public int getContextualTaskGroupCount()
Returns the number of contextual task groups inthis
ribbon.- Returns:
- Number of contextual task groups in
this
ribbon. - See Also:
addContextualTaskGroup(RibbonContextualTaskGroup)
,getContextualTaskGroup(int)
-
getContextualTaskGroup
public RibbonContextualTaskGroup getContextualTaskGroup(int index)
Retrieves contextual task group at specified index.- Parameters:
index
- Group index.- Returns:
- Group that matches the specified index.
- See Also:
addContextualTaskGroup(RibbonContextualTaskGroup)
,getContextualTaskGroupCount()
-
setSelectedTask
public void setSelectedTask(RibbonTask task)
Selects the specified task. The task can be either regular (added withaddTask(RibbonTask)
) or a task in a visible contextual task group (added withaddContextualTaskGroup(RibbonContextualTaskGroup)
. Fires aselectedTask
property change event.- Parameters:
task
- Task to select.- Throws:
java.lang.IllegalArgumentException
- If the specified task is not in the ribbon or not visible.- See Also:
getSelectedTask()
-
getSelectedTask
public RibbonTask getSelectedTask()
Returns the currently selected task.- Returns:
- The currently selected task.
- See Also:
setSelectedTask(RibbonTask)
-
updateUI
public void updateUI()
- Overrides:
updateUI
in classjavax.swing.JComponent
-
getUI
public RibbonUI getUI()
Returns the UI delegate for this component.- Overrides:
getUI
in classjavax.swing.JComponent
- Returns:
- a
RibbonUI
object - See Also:
JComponent.setUI(javax.swing.plaf.ComponentUI)
-
getUIClassID
public java.lang.String getUIClassID()
- Overrides:
getUIClassID
in classjavax.swing.JComponent
-
getTaskbarComponents
public java.util.List<java.awt.Component> getTaskbarComponents()
-
addChangeListener
public void addChangeListener(javax.swing.event.ChangeListener l)
Adds the specified change listener to track changes to this ribbon.- Parameters:
l
- Change listener to add.- See Also:
removeChangeListener(ChangeListener)
-
removeChangeListener
public void removeChangeListener(javax.swing.event.ChangeListener l)
Removes the specified change listener from tracking changes to this ribbon.- Parameters:
l
- Change listener to remove.- See Also:
addChangeListener(ChangeListener)
-
fireStateChanged
protected void fireStateChanged()
Notifies all registered listeners that the state of this ribbon has changed.
-
setVisible
public void setVisible(RibbonContextualTaskGroup group, boolean isVisible)
Sets the visibility of ribbon tasks in the specified contextual task group. Visibility of all ribbon tasks in the specified group is affected. Note that the ribbon can show ribbon tasks of multiple groups at the same time.- Parameters:
group
- Contextual task group.isVisible
- Iftrue
, all ribbon tasks in the specified group will be visible. Iffalse
, all ribbon tasks in the specified group will be hidden.- See Also:
isVisible(RibbonContextualTaskGroup)
-
isVisible
public boolean isVisible(RibbonContextualTaskGroup group)
Returns the visibility of ribbon tasks in the specified contextual task group.- Parameters:
group
- Contextual task group.- Returns:
true
if the ribbon tasks in the specified group are visible,false
otherwise.
-
setApplicationMenuCommand
public void setApplicationMenuCommand(RibbonApplicationMenuCommandButtonProjection applicationMenuCommandProjection)
Sets the application menu command for this ribbon. Ifnull
is passed, the application menu button is hidden.- Parameters:
applicationMenuCommandProjection
- The new application menu command. Can benull
.- See Also:
getApplicationMenuProjection()
-
getApplicationMenuCommandProjection
public RibbonApplicationMenuCommandButtonProjection getApplicationMenuCommandProjection()
-
getApplicationMenuProjection
public RibbonApplicationMenuProjection getApplicationMenuProjection()
Returns the application menu of this ribbon.- Returns:
- The application menu of this ribbon.
- See Also:
setApplicationMenuCommand(RibbonApplicationMenuCommandButtonProjection)
-
isMinimized
public boolean isMinimized()
Returns the indication whether this ribbon is minimized.- Returns:
true
if this ribbon is minimized,false
otherwise.- See Also:
setMinimized(boolean)
-
setMinimized
public void setMinimized(boolean isMinimized)
Changes the minimized state of this ribbon. Fires aminimized
property change event.- Parameters:
isMinimized
- iftrue
, this ribbon becomes minimized, otherwise it is unminimized.
-
getRibbonFrame
public JRibbonFrame getRibbonFrame()
Returns the ribbon frame that hosts this ribbon. The result can benull
.- Returns:
- The ribbon frame that hosts this ribbon.
-
setVisible
public void setVisible(boolean flag)
- Overrides:
setVisible
in classjavax.swing.JComponent
-
setOnShowContextualMenuListener
public void setOnShowContextualMenuListener(JRibbon.OnShowContextualMenuListener onShowContextualMenuListener)
-
getOnShowContextualMenuListener
public JRibbon.OnShowContextualMenuListener getOnShowContextualMenuListener()
-
addOnTaskSelectionChangedListener
public void addOnTaskSelectionChangedListener(JRibbon.OnTaskSelectionChangeListener listener)
-
removeOnTaskSelectionChangedListener
public void removeOnTaskSelectionChangedListener(JRibbon.OnTaskSelectionChangeListener listener)
-
fireTaskSelectionChanged
private void fireTaskSelectionChanged()
-
-