Package org.apache.juneau.console.widgets

Class EventCategory

java.lang.Object

org.apache.juneau.console.widgets.EventCategory

public class EventCategory
extends Object

A declared calendar event category — a legend entry and the color family its events paint with.

The color is a fixed token family (EventCategory.CategoryColor), never an author-supplied inline color, so the emitted markup only ever carries a jc-cal-cat--{blue|green|amber|red|neutral} class built from the sanitized id/color — no CSS-value injection surface. Legend text and tooltip are painted with textContent.

Since:

10.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	EventCategory.CategoryColor	The fixed category color families, each mapped to an existing --jc-tag-* token family.

Field Summary

Fields

Modifier and Type	Field	Description
EventCategory.CategoryColor	color	Fixed token family; defaults to EventCategory.CategoryColor.NEUTRAL.
String	description	Optional legend tooltip; painted with textContent.
String	id	Stable, unique id; charset [A-Za-z][A-Za-z0-9_-]*; drives the color class.
String	label	Legend text; painted with textContent.

Constructor Summary

Constructors

Constructor	Description
EventCategory()

Method Summary

Modifier and Type	Method	Description
EventCategory	color(EventCategory.CategoryColor value)	Sets the color family.
static EventCategory	create()	Creates an empty category.
EventCategory	description(String value)	Sets the legend tooltip.
EventCategory.CategoryColor	effectiveColor()	The effective color family — the declared color or EventCategory.CategoryColor.NEUTRAL when unset.
EventCategory	id(String value)	Sets the id.
EventCategory	label(String value)	Sets the legend label.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

id

public String id

Stable, unique id; charset [A-Za-z][A-Za-z0-9_-]*; drives the color class.

label

public String label

Legend text; painted with textContent.

color

public EventCategory.CategoryColor color

Fixed token family; defaults to EventCategory.CategoryColor.NEUTRAL.

description

public String description

Optional legend tooltip; painted with textContent.

Constructor Details

EventCategory

public EventCategory()

Method Details

create

public static EventCategory create()

Creates an empty category.

Returns:

A new EventCategory.

id

public EventCategory id(String value)

Sets the id.

Parameters:

value - The id. Must match [A-Za-z][A-Za-z0-9_-]*.

Returns:

This object.

label

public EventCategory label(String value)

Sets the legend label.

Parameters:

value - The label. Must not be null or blank.

Returns:

This object.

color

public EventCategory color(EventCategory.CategoryColor value)

Sets the color family.

Parameters:

value - The color family.

Returns:

This object.

description

public EventCategory description(String value)

Sets the legend tooltip.

Parameters:

value - The tooltip.

Returns:

This object.

effectiveColor

public EventCategory.CategoryColor effectiveColor()

The effective color family — the declared color or EventCategory.CategoryColor.NEUTRAL when unset.

Returns:

The effective color family.