public class RibbonContextualTaskGroup extends Object
RibbonTask
s. 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
JRibbon.addContextualTaskGroup(RibbonContextualTaskGroup)
are not
visible. To show the tasks belonging to the specific group, call
JRibbon.setVisible(RibbonContextualTaskGroup, boolean)
API. Note that
you can have multiple task groups visible at the same time. This class is a
logical entity that groups ribbon tasks belonging to the same contextual
group.Modifier and Type | Field | Description |
---|---|---|
static double |
HUE_ALPHA |
Alpha factor for colorizing the toggle tab buttons of tasks in contextual
groups.
|
Constructor | Description |
---|---|
RibbonContextualTaskGroup(String title,
Color hueColor,
RibbonTask... tasks) |
Creates a task contextual group that contains the specified tasks.
|
Modifier and Type | Method | Description |
---|---|---|
Color |
getHueColor() |
Returns the hue color for this group.
|
RibbonTask |
getTask(int index) |
Returns task at the specified index from
this group. |
int |
getTaskCount() |
Returns the number of tasks in
this group. |
String |
getTitle() |
Returns the name of this group.
|
void |
setTitle(String title) |
Changes the title of this ribbon contextual task group.
|
String |
toString() |
public static final double HUE_ALPHA
public RibbonContextualTaskGroup(String title, Color hueColor, RibbonTask... tasks)
title
- Group title.hueColor
- Hue color for this group. Should be a saturated non-dark color
for good visuals.tasks
- Tasks to add to the group.public int getTaskCount()
this
group.this
group.getTask(int)
public RibbonTask getTask(int index)
this
group.index
- Task index.getTaskCount()
public String getTitle()
setTitle(String)
public Color getHueColor()
public void setTitle(String title)
title
- The new title for this ribbon contextual task group.getTitle()