org.xwiki.livedata

Class LiveDataLayoutDescriptor

java.lang.Object

org.xwiki.livedata.WithParameters

org.xwiki.livedata.BaseDescriptor

org.xwiki.livedata.LiveDataLayoutDescriptor

@Unstable
public class LiveDataLayoutDescriptor
extends BaseDescriptor

Holds the layout configuration.

Since:

12.10

Version:

$Id: f6646e44690d32b186a9b1f8e4cddca62d79e6b7 $

Constructor Summary

Constructors

Constructor and Description
LiveDataLayoutDescriptor() Default constructor.
LiveDataLayoutDescriptor(String id) Creates a descriptor for the layout with the given id.

Method Summary

Modifier and Type	Method and Description
Map<String,Object>	getIcon()
String	getName()
void	initialize() Prevent null values where it's possible.
void	setIcon(Map<String,Object> icon) Set the icon meta data.
void	setName(String name) Set the layout pretty name.

Methods inherited from class org.xwiki.livedata.BaseDescriptor

equals, getId, hashCode, setId

Methods inherited from class org.xwiki.livedata.WithParameters

getParameters, setParameter

Methods inherited from class java.lang.Object

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

Constructor Detail

LiveDataLayoutDescriptor

public LiveDataLayoutDescriptor()

Default constructor.

LiveDataLayoutDescriptor

public LiveDataLayoutDescriptor(String id)

Creates a descriptor for the layout with the given id.

Parameters:

id - the layout id

Method Detail

getName

public String getName()

Returns:

the layout pretty name

setName

public void setName(String name)

Set the layout pretty name.

Parameters:

name - the new layout name

getIcon

public Map<String,Object> getIcon()

Returns:

the icon meta data

setIcon

public void setIcon(Map<String,Object> icon)

Set the icon meta data.

Parameters:

icon - the icon meta data

initialize

public void initialize()

Prevent null values where it's possible.