Class RibbonTask

java.lang.Object
org.pushingpixels.radiance.component.api.ribbon.RibbonTask
public class RibbonTask extends Object
Single ribbon task in JRibbon. This is a logical entity that groups AbstractRibbonBand components.

  • Field Details

    • ribbon

      private JRibbon ribbon
      The associated ribbon.

    • bands

      private ArrayList<AbstractRibbonBand> bands
      List of all bands.

    • title

      private String title
      The title of this task.

    • contextualGroup

      private RibbonContextualTaskGroup contextualGroup
      The group that this band belongs to. For regular ribbon bands this field is null.

    • resizeSequencingPolicy

      private RibbonBandResizeSequencingPolicy resizeSequencingPolicy
      The current resize sequencing policy.

    • keyTip

      private String keyTip
      The key tip for the task button of this task.

  • Constructor Details

    • RibbonTask

      public RibbonTask(String title, AbstractRibbonBand... bands)
      Creates a ribbon task that contains the specified bands.
      Parameters:
      title - Ribbon task title.
      bands - Bands to add to the ribbon task.

    • RibbonTask

      public RibbonTask(String title, Iterable<AbstractRibbonBand> bands)
      Creates a ribbon task that contains the specified bands.
      Parameters:
      title - Ribbon task title.
      bands - Bands to add to the ribbon task.

  • Method Details

    • getBandCount

      public int getBandCount()
      Returns the number of bands in this task.
      Returns:
      Number of bands in this task.
      See Also:

    • getBand

      public AbstractRibbonBand getBand(int index)
      Returns band at the specified index from this task.
      Parameters:
      index - Band index.
      Returns:
      Band at the specified index.
      See Also:

    • getTitle

      public String getTitle()
      Returns the title of this task.
      Returns:
      The title of this task.

    • setContextualGroup

      void setContextualGroup(RibbonContextualTaskGroup contextualGroup)
      Sets the contextual task group for this ribbon task. This method is package protected and is for internal use only.
      Parameters:
      contextualGroup - The contextual task group for this ribbon task.
      See Also:

    • getContextualGroup

      public RibbonContextualTaskGroup getContextualGroup()
      Returns the contextual task group for this ribbon task. Will return null for general ribbon tasks.
      Returns:
      The contextual task group for this ribbon task.

    • getBands

      public List<AbstractRibbonBand> getBands()
      Returns an unmodifiable view on the ribbon bands of this task.
      Returns:
      Unmodifiable view on the ribbon bands of this task.
      See Also:

    • setTitle

      public void setTitle(String title)
      Changes the title of this ribbon task.
      Parameters:
      title - The new title for this ribbon task.

    • setRibbon

      void setRibbon(JRibbon ribbon)
      Associates this ribbon task with the specified ribbon. This method is package protected and is for internal use only.
      Parameters:
      ribbon - The associated ribbon.

    • getResizeSequencingPolicy

      public RibbonBandResizeSequencingPolicy getResizeSequencingPolicy()
      Returns the current resize sequencing policy of this ribbon task.
      Returns:
      The current resize sequencing policy of this ribbon task.
      See Also:

    • setResizeSequencingPolicy

      public void setResizeSequencingPolicy(RibbonBandResizeSequencingPolicy resizeSequencingPolicy)
      Sets the specified parameter as the new resize sequencing policy of this ribbon task.
      Parameters:
      resizeSequencingPolicy - The new resize sequencing policy of this ribbon task.
      See Also:

    • getKeyTip

      public String getKeyTip()
      Returns the key tip for the task button of this task.
      Returns:
      The key tip for the task button of this task.
      See Also:

    • setKeyTip

      public void setKeyTip(String keyTip)
      Sets the specified parameter to be the new key tip for the task button of this task.
      Parameters:
      keyTip - The new key tip for the task button of this task.