Class JRibbon

Method Details

• addTaskbarComponent

  public void addTaskbarComponent(Component comp)

  Adds the specified taskbar component to this ribbon.

  Taskbar components are small components placed to the right of the application menu. These components usually perform an action common among the entire application.

  Parameters:

  comp - the taskbar component to add

  See Also:

  • removeTaskbarComponent(Component)
  • removeAllTaskbarComponents()
  • getTaskbarComponents()

• removeTaskbarComponent

  public void removeTaskbarComponent(Component comp)

  Removes the specified taskbar component from this ribbon.

  Parameters:

  comp - The taskbar component to remove.

  See Also:

  • addTaskbarComponent(Component)
  • getTaskbarComponents()
  • removeAllTaskbarComponents()

• removeAllTaskbarComponents

  public void removeAllTaskbarComponents()

  Removes all components added to the taskbar of the ribbon.

  See Also:

  • addTaskbarComponent(Component)
  • getTaskbarComponents()
  • removeTaskbarComponent(Component)

• 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)

• removeTask

  public void removeTask(int pos)

  Removes the task at the specified position, if it represents a valid task. Throws an IndexOutOfBoundsException if not.

  Parameters:

  pos - The position of the task to remove.

• removeTask

  public void removeTask(RibbonTask task)

  Removes the given task from the ribbon. If this is the currently visible task, the ribbon will move to the task to its left, unless the removed task is the left-most, in which case it will move to the next task to the right.

  Parameters:

  task - The ribbon task to be removed from the panel.

  Throws:

  IllegalArgumentException - if task is null

• removeAllTasks

  public void removeAllTasks()

  Removes all tasks from the ribbon.

• configureHelp

  public void configureHelp(ResizableIcon helpIcon, ActionListener helpActionListener)

  Configures the help button of this ribbon.

  Parameters:

  helpIcon - The icon for the help button.

  helpActionListener - The action listener for the help button.

  See Also:

  • getHelpIcon()
  • getHelpActionListener()

• getHelpIcon

  public ResizableIcon getHelpIcon()

  Returns the icon for the help button. Will return null if the help button has not been configured with the configureHelp(ResizableIcon, ActionListener) API.

  Returns:

  The icon for the help button.

  See Also:

  • configureHelp(ResizableIcon, ActionListener)
  • getHelpActionListener()

• getHelpActionListener

  public ActionListener getHelpActionListener()

  Returns the action listener for the help button. Will return null if the help button has not been configured with the configureHelp(ResizableIcon, ActionListener) API.

  Returns:

  The action listener for the help button.

  See Also:

  • configureHelp(ResizableIcon, ActionListener)
  • getHelpIcon()

• setHelpRichTooltip

  public void setHelpRichTooltip(RichTooltip tooltip)

  Sets the rich tooltip of the help button. Fires an stateChanged event.

  Parameters:

  tooltip - The rich tooltip of the help button.

  See Also:

  • getHelpRichTooltip()
  • configureHelp(org.pushingpixels.flamingo.api.common.icon.ResizableIcon, java.awt.event.ActionListener)

• getHelpRichTooltip

  public RichTooltip getHelpRichTooltip()

  Returns the rich tooltip of the help button.

  Returns:

  The rich tooltip of the help button.

  See Also:

  • setHelpRichTooltip(org.pushingpixels.flamingo.api.common.RichTooltip)
  • configureHelp(org.pushingpixels.flamingo.api.common.icon.ResizableIcon, java.awt.event.ActionListener)

• addHelpPanelComponent

  public void addHelpPanelComponent(Component comp)

  Adds a component to the 'Help Panel.' This is the area where the help button lives. and is the far right area of the main tab area. Components will be added in left to right fashion, Also, if a help listener is specified then the help button will be the rightmost component on the list. Generally speaking this area should not be abused, as any large amount of components will cause the space available for the task tabs to shrink. This is the area where you would add a "collapse" button like found in Office 2010, or the min/max/close buttons of an integrated desktop area.

  Parameters:

  comp - the component to be added

• removeHelpPanelComponent

  public void removeHelpPanelComponent(Component comp)

  Removes a component from the 'Help Panel'.

  Parameters:

  comp - The component to remove. If the component is not currently on the help panel this call will be a no-op.

• removeAllHelpPanelComponents

  public void removeAllHelpPanelComponents()

  Removes al the components from the 'Help Panel'.

• 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 in this ribbon. This does not include the contextual ribbon tasks.

  To find the total number of ribbon tasks (including contextual ribbon tasks) you will have to iterate through the contextual task groups.

  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:

  the task that matches the specified index

  See Also:

  • getTaskCount()
  • addTask(RibbonTask)

• getContextualTaskGroupCount

  public int getContextualTaskGroupCount()

  Returns the number of contextual task groups in this 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 with addTask(RibbonTask)) or a task in a visible contextual task group (added with addContextualTaskGroup(RibbonContextualTaskGroup). Fires a selectedTask property change event.

  Parameters:

  task - task to select

  Throws:

  IllegalArgumentException - if task is not in the ribbon, is null, 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 class JComponent

• getUI

  public RibbonUI getUI()

  Returns the UI object which implements the L&F for this component.

  Overrides:

  getUI in class JComponent

  Returns:

  a RibbonUI object

  See Also:

  • JComponent.setUI(javax.swing.plaf.ComponentUI)

• getUIClassID

  public String getUIClassID()

  Overrides:

  getUIClassID in class JComponent

• getTaskbarComponents

  public List<Component> getTaskbarComponents()

  Gets an unmodifiable list of all taskbar components of this ribbon.

  Returns:

  All taskbar components of this ribbon.

  See Also:

  • addTaskbarComponent(Component)
  • removeTaskbarComponent(Component)

• addChangeListener

  public void addChangeListener(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(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 - If true, all ribbon tasks in the specified group will be visible. If false, 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.

• setApplicationMenu

  public void setApplicationMenu(RibbonApplicationMenu applicationMenu)

  Sets the application menu for this ribbon. If null is passed, the application menu button is hidden. Fires an applicationMenu property change event.

  Parameters:

  applicationMenu - The new application menu. Can be null.

  See Also:

  • getApplicationMenu()

• getApplicationMenu

  public RibbonApplicationMenu getApplicationMenu()

  Returns the application menu of this ribbon.

  Returns:

  The application menu of this ribbon.

  See Also:

  • setApplicationMenu(RibbonApplicationMenu)

• setApplicationMenuRichTooltip

  public void setApplicationMenuRichTooltip(RichTooltip tooltip)

  Sets the rich tooltip of the application menu button. Fires an applicationMenuRichTooltip property change event.

  Parameters:

  tooltip - The rich tooltip of the application menu button.

  See Also:

  • getApplicationMenuRichTooltip()
  • setApplicationMenu(RibbonApplicationMenu)

• getApplicationMenuRichTooltip

  public RichTooltip getApplicationMenuRichTooltip()

  Returns the rich tooltip of the application menu button.

  Returns:

  The rich tooltip of the application menu button.

  See Also:

  • setApplicationMenuRichTooltip(RichTooltip)
  • setApplicationMenu(RibbonApplicationMenu)

• setApplicationMenuKeyTip

  public void setApplicationMenuKeyTip(String keyTip)

  Sets the key tip of the application menu button. Fires an applicationMenuKeyTip property change event.

  Parameters:

  keyTip - The new key tip for the application menu button.

  See Also:

  • setApplicationMenu(RibbonApplicationMenu)
  • getApplicationMenuKeyTip()

• getApplicationMenuKeyTip

  public String getApplicationMenuKeyTip()

  Returns the key tip of the application menu button.

  Returns:

  The key tip of the application menu button.

  See Also:

  • setApplicationMenuKeyTip(String)
  • setApplicationMenu(RibbonApplicationMenu)

• 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 a minimized property change event.

  Parameters:

  isMinimized - if true, this ribbon becomes minimized, otherwise it is unminimized.

• getRibbonFrame

  @Deprecated public JRibbonFrame getRibbonFrame()

  Deprecated.

  Dropped support in order to decouple the JRibbon from the JRibbonFrame

  Returns the ribbon frame that hosts this ribbon. The result can be null.

  Returns:

  The ribbon frame that hosts this ribbon.

• setVisible

  public void setVisible(boolean flag)

  Overrides:

  setVisible in class JComponent

• getApplicationIcon

  public ResizableIcon getApplicationIcon()

  Returns the application icon. The application icon is displayed on the application menu button.

  This is a convenience method and is equivalent to getUI().getApplicationIcon().

  Returns:

  the application icon

  See Also:

  • getUI()
  • RibbonUI.getApplicationIcon()
  • setApplicationIcon(ResizableIcon)

• setApplicationIcon

  public void setApplicationIcon(ResizableIcon applicationIcon)

  Sets the application icon. This is displayed on the application menu button.

  There is no check performed to see if applicationIcon is null.

  A PropertyChangeEvent is fired for the PROPERTY_APPLICATION_ICON property.

  Parameters:

  applicationIcon - the application icon to set

  See Also:

  • getUI()
  • RibbonUI.setApplicationIcon(ResizableIcon)
  • getApplicationIcon()