Decoration

All Implemented Interfaces:

android.os.Parcelable , org.readium.r2.shared.JSONable
```
public final class Decoration
 implements JSONable, Parcelable
                    
```
A decoration is a user interface element drawn on top of a publication. It associates a style to be rendered with a discrete locator in the publication.
For example, decorations can be used to draw highlights, images or buttons.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public interface`	`Decoration.Style`	The Decoration Style determines the look and feel of a decoration once rendered by a Navigator. It is media type agnostic, meaning that each Navigator will translate the style into a set of rendering instructions which makes sense for the resource type.

Field Summary

Fields
Modifier and Type	Field	Description
`private final String`	`id`
`private final Locator`	`locator`
`private final Decoration.Style`	`style`
`private final Map<String, Object>`	`extras`

Constructor Summary

Constructors
Constructor	Description
`Decoration(String id, Locator locator, Decoration.Style style, Map<String, Object> extras)`

Method Summary

Modifier and Type	Method	Description
`final String`	`getId()`
`final Locator`	`getLocator()`
`final Decoration.Style`	`getStyle()`
`final Map<String, Object>`	`getExtras()`
`JSONObject`	`toJSON()`

Methods inherited from class org.readium.r2.navigator.Decoration
describeContents, writeToParcel
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Decoration
```
Decoration(String id, Locator locator, Decoration.Style style, Map<String, Object> extras)
```
    Parameters:
    
    id - An identifier for this decoration.
    
    locator - Location in the publication where the decoration will be rendered.
    
    style - Declares the look and feel of the decoration.
    
    extras - Additional context data specific to a reading app.
- Method Detail
  - getId
```
 final String getId()
```
  - getLocator
```
 final Locator getLocator()
```
  - getStyle
```
 final Decoration.Style getStyle()
```
  - getExtras
```
 final Map<String, Object> getExtras()
```
  - toJSON
```
 JSONObject toJSON()
```