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.

See Also:

  • Field Details

  • 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

    • initRibbon

      private void initRibbon()
      Initializes the layout and the ribbon.

    • 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

    • isValidPopupTriggerSource

      private boolean isValidPopupTriggerSource(Component c)

    • isInTaskbar

      private boolean isInTaskbar(Component c)

    • handlePopupTrigger

      private void handlePopupTrigger(MouseEvent event, Component c)

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

    • setApplicationAndMenuButtonIcon

      private void setApplicationAndMenuButtonIcon(RadianceIcon.Factory iconFactory)

    • setLegacyIconImages

      private void setLegacyIconImages(List<Image> images)

    • getImage

      private static Image getImage(RadianceIcon.Factory iconFactory, int size)

    • 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

      private List<RibbonTask> getAllShownRibbonTasks()

    • getNextRibbonTask

      private RibbonTask getNextRibbonTask()

    • getPreviousRibbonTask

      private RibbonTask getPreviousRibbonTask()