FigureStyle (Figure Macro 15.4 API)

java.lang.Object
- java.lang.Enum<FigureStyle>
- - org.xwiki.contrib.figure.FigureStyle

All Implemented Interfaces:

Serializable, Comparable<FigureStyle>
```
@Unstable
public enum FigureStyle
extends Enum<FigureStyle>
```
The style of the figure. The style impacts the way the figure will be rendered, in pages, WYSIWYG editors, and exports (e.g., LaTeX exports).

Since:

15.4

Version:

$Id$

Enum Constant Summary

Enum Constants
Enum Constant Description

BLOCK
The block style.

INLINE
The inline style.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getName()`
`static FigureStyle`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static FigureStyle[]`	`values()`	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

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

- Enum Constant Detail
  - BLOCK
```
public static final FigureStyle BLOCK
```
    The block style.
  - INLINE
```
public static final FigureStyle INLINE
```
    The inline style.
- Method Detail
  - values
```
public static FigureStyle[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
    for (FigureStyle c : FigureStyle.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static FigureStyle valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - getName
```
public String getName()
```
    Returns:
    
    the name of the style