java.lang.Object
- org.apache.myfaces.tobago.context.Markup

All Implemented Interfaces:

Serializable, Iterable<String>
```
public final class Markup
extends Object
implements Serializable, Iterable<String>
```
A markup signs a component to be rendered different from the normal. E. g. markup="emphasized" might be rendered bold or a markup="deleted" might be rendered with line-through style. The concrete rendering depends from the theme.

The markup can also hold more than one value, e. g. markup="emphasized, deleted".

The value of the markup is unmodifiable.

A markup must be registered for a component, before it can be used.

A markup should only contain ASCII characters and digits.

In JSPs the class MarkupEditor will convert the string literals.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field	Description
`static Markup`	`ASCENDING`
`static Markup`	`BADGE`
`static Markup`	`BIG`
`static Markup`	`BOLD`
`static Markup`	`BORDERED`
`static Markup`	`BOTTOM`
`static Markup`	`CENTER`
`static Markup`	`CLICKABLE`
`static Markup`	`DANGER`
`static Markup`	`DARK`
`static Markup`	`DEFAULT`
`static Markup`	`DELETED`
`static Markup`	`DESCENDING`
`static Markup`	`DISABLED`
`static Markup`	`ERROR`
`static Markup`	`EVEN`
`static Markup`	`EXPANDED`
`static Markup`	`EXTRA_LARGE`
`static Markup`	`FATAL`
`static Markup`	`FILLER`
`static Markup`	`FIRST`	Deprecated. Can be selected via CSS3.
`static Markup`	`FOLDER`
`static Markup`	`HOVER`
`static Markup`	`INFO`
`static Markup`	`INLINE`
`static Markup`	`INVERSE`	Deprecated. since 4.0.0, please use `DARK`
`static Markup`	`ITALIC`
`static Markup`	`JUSTIFY`
`static Markup`	`LARGE`
`static Markup`	`LEFT`
`static Markup`	`LIGHT`
`static Markup`	`LOCAL_MENU`
`static Markup`	`MARKED`
`static Markup`	`MEDIUM`
`static Markup`	`MIDDLE`
`static Markup`	`MODAL`
`static Markup`	`NONE`
`static Markup`	`NULL`
`static Markup`	`NUMBER`
`static Markup`	`ODD`
`static Markup`	`OUTLINE_DANGER`
`static Markup`	`OUTLINE_DARK`
`static Markup`	`OUTLINE_INFO`
`static Markup`	`OUTLINE_LIGHT`
`static Markup`	`OUTLINE_PRIMARY`
`static Markup`	`OUTLINE_SECONDARY`
`static Markup`	`OUTLINE_SUCCESS`
`static Markup`	`OUTLINE_WARNING`
`static Markup`	`PILL`
`static Markup`	`PORTLET`
`static Markup`	`PRIMARY`
`static Markup`	`READONLY`
`static Markup`	`REQUIRED`
`static Markup`	`RESIZABLE`
`static Markup`	`RIGHT`
`static Markup`	`SECONDARY`
`static Markup`	`SECONDS`
`static Markup`	`SELECTED`
`static Markup`	`SHEET_DESELECT_ALL`	Deprecated. since 3.0.4
`static Markup`	`SHEET_SELECT_ALL`	Deprecated. since 3.0.4
`static Markup`	`SHEET_TOGGLE_ALL`	Deprecated. since 3.0.4
`static Markup`	`SMALL`
`static Markup`	`SORTABLE`
`static Markup`	`SPREAD`
`static String`	`STRING_ASCENDING`
`static String`	`STRING_BADGE`
`static String`	`STRING_BIG`
`static String`	`STRING_BOLD`
`static String`	`STRING_BORDERED`
`static String`	`STRING_BOTTOM`
`static String`	`STRING_CENTER`
`static String`	`STRING_CLICKABLE`
`static String`	`STRING_DANGER`
`static String`	`STRING_DARK`
`static String`	`STRING_DEFAULT`
`static String`	`STRING_DELETED`
`static String`	`STRING_DESCENDING`
`static String`	`STRING_DISABLED`
`static String`	`STRING_ERROR`
`static String`	`STRING_EVEN`
`static String`	`STRING_EXPANDED`
`static String`	`STRING_EXTRA_LARGE`
`static String`	`STRING_FATAL`
`static String`	`STRING_FILLER`
`static String`	`STRING_FIRST`	Deprecated. Can be selected via CSS3.
`static String`	`STRING_FOLDER`
`static String`	`STRING_HOVER`
`static String`	`STRING_INFO`
`static String`	`STRING_INLINE`
`static String`	`STRING_INVERSE`	Deprecated. since 4.0.0, please use `DARK`
`static String`	`STRING_ITALIC`
`static String`	`STRING_JUSTIFY`
`static String`	`STRING_LARGE`
`static String`	`STRING_LEFT`
`static String`	`STRING_LIGHT`
`static String`	`STRING_LOCAL_MENU`
`static String`	`STRING_MARKED`
`static String`	`STRING_MEDIUM`
`static String`	`STRING_MIDDLE`
`static String`	`STRING_MODAL`
`static String`	`STRING_NONE`
`static String`	`STRING_NUMBER`
`static String`	`STRING_ODD`
`static String`	`STRING_OUTLINE_DANGER`
`static String`	`STRING_OUTLINE_DARK`
`static String`	`STRING_OUTLINE_INFO`
`static String`	`STRING_OUTLINE_LIGHT`
`static String`	`STRING_OUTLINE_PRIMARY`
`static String`	`STRING_OUTLINE_SECONDARY`
`static String`	`STRING_OUTLINE_SUCCESS`
`static String`	`STRING_OUTLINE_WARNING`
`static String`	`STRING_PILL`
`static String`	`STRING_PORTLET`
`static String`	`STRING_PRIMARY`
`static String`	`STRING_READONLY`
`static String`	`STRING_REQUIRED`
`static String`	`STRING_RESIZABLE`
`static String`	`STRING_RIGHT`
`static String`	`STRING_SECONDARY`
`static String`	`STRING_SECONDS`
`static String`	`STRING_SELECTED`
`static String`	`STRING_SHEET_DESELECT_ALL`	Deprecated. since 3.0.4
`static String`	`STRING_SHEET_SELECT_ALL`	Deprecated. since 3.0.4
`static String`	`STRING_SHEET_TOGGLE_ALL`	Deprecated. since 3.0.4
`static String`	`STRING_SMALL`
`static String`	`STRING_SORTABLE`
`static String`	`STRING_SPREAD`
`static String`	`STRING_STRIPED`
`static String`	`STRING_STRONG`
`static String`	`STRING_SUCCESS`
`static String`	`STRING_THIN`
`static String`	`STRING_TOGGLER_LEFT`
`static String`	`STRING_TOP`
`static String`	`STRING_VERTICALLY`
`static String`	`STRING_WARN`
`static String`	`STRING_WARNING`
`static Markup`	`STRIPED`
`static Markup`	`STRONG`
`static Markup`	`SUCCESS`
`static Markup`	`THIN`
`static Markup`	`TOGGLER_LEFT`
`static Markup`	`TOP`
`static Markup`	`VERTICALLY`
`static Markup`	`WARN`
`static Markup`	`WARNING`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Markup`	`add(Markup markup)`	Adds one markup to an other.
`boolean`	`contains(String markup)`
`boolean`	`contains(Markup markup)`
`boolean`	`equals(Object o)`
`int`	`hashCode()`
`boolean`	`isEmpty()`	Check if there is no value set inside this markup.
`Iterator<String>`	`iterator()`
`Markup`	`remove(Markup markup)`
`String`	`toString()`
`static Markup`	`valueOf(Object value)`
`static Markup`	`valueOf(String value)`
`static Markup`	`valueOf(String[] values)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable
forEach, spliterator

Field Detail

NULL
```
public static final Markup NULL
```

ASCENDING
```
public static final Markup ASCENDING
```

BADGE
```
public static final Markup BADGE
```

BIG
```
public static final Markup BIG
```

BOLD
```
public static final Markup BOLD
```

BORDERED
```
public static final Markup BORDERED
```

BOTTOM
```
public static final Markup BOTTOM
```

CENTER
```
public static final Markup CENTER
```

CLICKABLE
```
public static final Markup CLICKABLE
```

DANGER
```
public static final Markup DANGER
```

DARK
```
public static final Markup DARK
```

DEFAULT
```
public static final Markup DEFAULT
```

DELETED
```
public static final Markup DELETED
```

DESCENDING
```
public static final Markup DESCENDING
```

DISABLED
```
public static final Markup DISABLED
```

ERROR
```
public static final Markup ERROR
```

EVEN
```
public static final Markup EVEN
```

EXPANDED
```
public static final Markup EXPANDED
```

EXTRA_LARGE
```
public static final Markup EXTRA_LARGE
```

FILLER
```
public static final Markup FILLER
```

FATAL
```
public static final Markup FATAL
```

FIRST

@Deprecated
public static final Markup FIRST

Deprecated.

Can be selected via CSS3.

FOLDER
```
public static final Markup FOLDER
```

HOVER
```
public static final Markup HOVER
```

INFO
```
public static final Markup INFO
```

INLINE
```
public static final Markup INLINE
```

ITALIC
```
public static final Markup ITALIC
```

JUSTIFY
```
public static final Markup JUSTIFY
```

INVERSE

@Deprecated
public static final Markup INVERSE

Deprecated.

since 4.0.0, please use DARK

LARGE
```
public static final Markup LARGE
```

LEFT
```
public static final Markup LEFT
```

LIGHT
```
public static final Markup LIGHT
```

LOCAL_MENU
```
public static final Markup LOCAL_MENU
```

MARKED
```
public static final Markup MARKED
```

MEDIUM
```
public static final Markup MEDIUM
```

MIDDLE
```
public static final Markup MIDDLE
```

MODAL
```
public static final Markup MODAL
```

NONE
```
public static final Markup NONE
```

NUMBER
```
public static final Markup NUMBER
```

ODD
```
public static final Markup ODD
```

OUTLINE_DANGER

public static final Markup OUTLINE_DANGER

OUTLINE_DARK

public static final Markup OUTLINE_DARK

OUTLINE_INFO

public static final Markup OUTLINE_INFO

OUTLINE_LIGHT

public static final Markup OUTLINE_LIGHT

OUTLINE_PRIMARY

public static final Markup OUTLINE_PRIMARY

OUTLINE_SECONDARY

public static final Markup OUTLINE_SECONDARY

OUTLINE_SUCCESS

public static final Markup OUTLINE_SUCCESS

OUTLINE_WARNING

public static final Markup OUTLINE_WARNING

PILL
```
public static final Markup PILL
```

PORTLET
```
public static final Markup PORTLET
```

PRIMARY
```
public static final Markup PRIMARY
```

READONLY
```
public static final Markup READONLY
```

REQUIRED
```
public static final Markup REQUIRED
```

RESIZABLE
```
public static final Markup RESIZABLE
```

RIGHT
```
public static final Markup RIGHT
```

SECONDARY
```
public static final Markup SECONDARY
```

SECONDS
```
public static final Markup SECONDS
```

SELECTED
```
public static final Markup SELECTED
```

SHEET_SELECT_ALL

@Deprecated
public static final Markup SHEET_SELECT_ALL

Deprecated.

since 3.0.4

SHEET_DESELECT_ALL

@Deprecated
public static final Markup SHEET_DESELECT_ALL

Deprecated.

since 3.0.4

SHEET_TOGGLE_ALL

@Deprecated
public static final Markup SHEET_TOGGLE_ALL

Deprecated.

since 3.0.4

SMALL
```
public static final Markup SMALL
```

SORTABLE
```
public static final Markup SORTABLE
```

SPREAD
```
public static final Markup SPREAD
```

STRIPED
```
public static final Markup STRIPED
```

STRONG
```
public static final Markup STRONG
```

SUCCESS
```
public static final Markup SUCCESS
```

THIN
```
public static final Markup THIN
```

TOGGLER_LEFT

public static final Markup TOGGLER_LEFT

TOP
```
public static final Markup TOP
```

VERTICALLY
```
public static final Markup VERTICALLY
```

WARN
```
public static final Markup WARN
```

WARNING
```
public static final Markup WARNING
```

STRING_ASCENDING

public static final String STRING_ASCENDING

See Also:: Constant Field Values

STRING_BADGE

public static final String STRING_BADGE

See Also:: Constant Field Values

STRING_BIG
```
public static final String STRING_BIG
```
See Also:

Constant Field Values

STRING_BOLD
```
public static final String STRING_BOLD
```
See Also:

Constant Field Values

STRING_BORDERED

public static final String STRING_BORDERED

See Also:: Constant Field Values

STRING_BOTTOM

public static final String STRING_BOTTOM

See Also:: Constant Field Values

STRING_CENTER

public static final String STRING_CENTER

See Also:: Constant Field Values

STRING_CLICKABLE

public static final String STRING_CLICKABLE

See Also:: Constant Field Values

STRING_DANGER

public static final String STRING_DANGER

See Also:: Constant Field Values

STRING_DARK
```
public static final String STRING_DARK
```
See Also:

Constant Field Values

STRING_DEFAULT

public static final String STRING_DEFAULT

See Also:: Constant Field Values

STRING_DELETED

public static final String STRING_DELETED

See Also:: Constant Field Values

STRING_DESCENDING

public static final String STRING_DESCENDING

See Also:: Constant Field Values

STRING_DISABLED

public static final String STRING_DISABLED

See Also:: Constant Field Values

STRING_ERROR

public static final String STRING_ERROR

See Also:: Constant Field Values

STRING_EVEN
```
public static final String STRING_EVEN
```
See Also:

Constant Field Values

STRING_EXPANDED

public static final String STRING_EXPANDED

See Also:: Constant Field Values

STRING_EXTRA_LARGE

public static final String STRING_EXTRA_LARGE

See Also:: Constant Field Values

STRING_FILLER

public static final String STRING_FILLER

See Also:: Constant Field Values

STRING_FATAL

public static final String STRING_FATAL

See Also:: Constant Field Values

STRING_FIRST
```
@Deprecated
public static final String STRING_FIRST
```
Deprecated.
Can be selected via CSS3.

See Also:

Constant Field Values

STRING_FOLDER

public static final String STRING_FOLDER

See Also:: Constant Field Values

STRING_HOVER

public static final String STRING_HOVER

See Also:: Constant Field Values

STRING_INFO
```
public static final String STRING_INFO
```
See Also:

Constant Field Values

STRING_INLINE

public static final String STRING_INLINE

See Also:: Constant Field Values

STRING_ITALIC

public static final String STRING_ITALIC

See Also:: Constant Field Values

STRING_JUSTIFY

public static final String STRING_JUSTIFY

See Also:: Constant Field Values

STRING_INVERSE
```
@Deprecated
public static final String STRING_INVERSE
```
Deprecated.
since 4.0.0, please use DARK

See Also:

Constant Field Values

STRING_LARGE

public static final String STRING_LARGE

See Also:: Constant Field Values

STRING_LEFT
```
public static final String STRING_LEFT
```
See Also:

Constant Field Values

STRING_LIGHT

public static final String STRING_LIGHT

See Also:: Constant Field Values

STRING_LOCAL_MENU

public static final String STRING_LOCAL_MENU

See Also:: Constant Field Values

STRING_MARKED

public static final String STRING_MARKED

See Also:: Constant Field Values

STRING_MEDIUM

public static final String STRING_MEDIUM

See Also:: Constant Field Values

STRING_MIDDLE

public static final String STRING_MIDDLE

See Also:: Constant Field Values

STRING_MODAL

public static final String STRING_MODAL

See Also:: Constant Field Values

STRING_NONE
```
public static final String STRING_NONE
```
See Also:

Constant Field Values

STRING_NUMBER

public static final String STRING_NUMBER

See Also:: Constant Field Values

STRING_ODD
```
public static final String STRING_ODD
```
See Also:

Constant Field Values

STRING_OUTLINE_DANGER

public static final String STRING_OUTLINE_DANGER

See Also:: Constant Field Values

STRING_OUTLINE_DARK

public static final String STRING_OUTLINE_DARK

See Also:: Constant Field Values

STRING_OUTLINE_INFO

public static final String STRING_OUTLINE_INFO

See Also:: Constant Field Values

STRING_OUTLINE_LIGHT

public static final String STRING_OUTLINE_LIGHT

See Also:: Constant Field Values

STRING_OUTLINE_PRIMARY

public static final String STRING_OUTLINE_PRIMARY

See Also:: Constant Field Values

STRING_OUTLINE_SECONDARY

public static final String STRING_OUTLINE_SECONDARY

See Also:: Constant Field Values

STRING_OUTLINE_SUCCESS

public static final String STRING_OUTLINE_SUCCESS

See Also:: Constant Field Values

STRING_OUTLINE_WARNING

public static final String STRING_OUTLINE_WARNING

See Also:: Constant Field Values

STRING_PILL
```
public static final String STRING_PILL
```
See Also:

Constant Field Values

STRING_PORTLET

public static final String STRING_PORTLET

See Also:: Constant Field Values

STRING_PRIMARY

public static final String STRING_PRIMARY

See Also:: Constant Field Values

STRING_READONLY

public static final String STRING_READONLY

See Also:: Constant Field Values

STRING_REQUIRED

public static final String STRING_REQUIRED

See Also:: Constant Field Values

STRING_RESIZABLE

public static final String STRING_RESIZABLE

See Also:: Constant Field Values

STRING_RIGHT

public static final String STRING_RIGHT

See Also:: Constant Field Values

STRING_SECONDARY

public static final String STRING_SECONDARY

See Also:: Constant Field Values

STRING_SECONDS

public static final String STRING_SECONDS

See Also:: Constant Field Values

STRING_SELECTED

public static final String STRING_SELECTED

See Also:: Constant Field Values

STRING_SHEET_SELECT_ALL
```
@Deprecated
public static final String STRING_SHEET_SELECT_ALL
```
Deprecated.
since 3.0.4

See Also:

Constant Field Values

STRING_SHEET_DESELECT_ALL
```
@Deprecated
public static final String STRING_SHEET_DESELECT_ALL
```
Deprecated.
since 3.0.4

See Also:

Constant Field Values

STRING_SHEET_TOGGLE_ALL
```
@Deprecated
public static final String STRING_SHEET_TOGGLE_ALL
```
Deprecated.
since 3.0.4

See Also:

Constant Field Values

STRING_SMALL

public static final String STRING_SMALL

See Also:: Constant Field Values

STRING_SORTABLE

public static final String STRING_SORTABLE

See Also:: Constant Field Values

STRING_SPREAD

public static final String STRING_SPREAD

See Also:: Constant Field Values

STRING_STRIPED

public static final String STRING_STRIPED

See Also:: Constant Field Values

STRING_STRONG

public static final String STRING_STRONG

See Also:: Constant Field Values

STRING_SUCCESS

public static final String STRING_SUCCESS

See Also:: Constant Field Values

STRING_THIN
```
public static final String STRING_THIN
```
See Also:

Constant Field Values

STRING_TOGGLER_LEFT

public static final String STRING_TOGGLER_LEFT

See Also:: Constant Field Values

STRING_TOP
```
public static final String STRING_TOP
```
See Also:

Constant Field Values

STRING_VERTICALLY

public static final String STRING_VERTICALLY

See Also:: Constant Field Values

STRING_WARN
```
public static final String STRING_WARN
```
See Also:

Constant Field Values

STRING_WARNING

public static final String STRING_WARNING

See Also:: Constant Field Values

Method Detail

valueOf

public static Markup valueOf(String[] values)

valueOf

public static Markup valueOf(String value)

valueOf

public static Markup valueOf(Object value)

equals
```
public boolean equals(Object o)
```
Overrides:

equals in class Object

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

iterator
```
public Iterator<String> iterator()
```
Specified by:

iterator in interface Iterable<String>

add
```
public Markup add(Markup markup)
```
Adds one markup to an other. Attention: The markup itself is not modified, you need to use the result of this operation.

remove

public Markup remove(Markup markup)

contains

public boolean contains(String markup)

contains

public boolean contains(Markup markup)

isEmpty
```
public boolean isEmpty()
```
Check if there is no value set inside this markup.

toString
```
public String toString()
```
Overrides:

toString in class Object

Class Markup

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Field Detail

NULL

ASCENDING

BADGE

BIG

BOLD

BORDERED

BOTTOM

CENTER

CLICKABLE

DANGER

DARK

DEFAULT

DELETED

DESCENDING

DISABLED

ERROR

EVEN

EXPANDED

EXTRA_LARGE

FILLER

FATAL

FIRST

FOLDER

HOVER

INFO

INLINE

ITALIC

JUSTIFY

INVERSE

LARGE

LEFT

LIGHT

LOCAL_MENU

MARKED

MEDIUM

MIDDLE

MODAL

NONE

NUMBER

ODD

OUTLINE_DANGER

OUTLINE_DARK

OUTLINE_INFO

OUTLINE_LIGHT

OUTLINE_PRIMARY

OUTLINE_SECONDARY

OUTLINE_SUCCESS

OUTLINE_WARNING

PILL

PORTLET

PRIMARY

READONLY

REQUIRED

RESIZABLE

RIGHT

SECONDARY

SECONDS

SELECTED

SHEET_SELECT_ALL

SHEET_DESELECT_ALL

SHEET_TOGGLE_ALL

SMALL

SORTABLE

SPREAD

STRIPED

STRONG

SUCCESS

THIN

TOGGLER_LEFT

TOP

VERTICALLY

WARN

WARNING

STRING_ASCENDING