Package se.conciliate.extensions.documents

Class MetaDataGroup

java.lang.Object

se.conciliate.extensions.documents.MetaDataGroup

public final class MetaDataGroup
extends Object

MetaDataGroup is used to construct a UI for editing and displaying a document. All MetaData belonging to the same group will be displayed in that group's edit area, currently a side-tab.

Method Summary

Modifier and Type	Method	Description
MetaDataGroup	addMetaDataType(MetaDataType<? extends MetaData<?>> type)
MetaDataGroup	addMetaDataTypes(List<? extends MetaDataType<? extends MetaData<?>>> types)
MetaDataGroup	addSeparator()	Adds a small gap between the last added meta data type and the next added meta data type.
static MetaDataGroup	createGroup(String ID, String title, URL icon)
static MetaDataGroup	createGroup(String title, URL icon)
List<MetaDataType<? extends MetaData<?>>>	getContentTypes()
URL	getIcon()
String	getID()
List<Integer>	getSeparatorIndices()
String	getTitle()
boolean	isDefaultGroup()
MetaDataGroup	setDefaultGroup(boolean defaultGroup)
MetaDataGroup	setIcon(URL icon)
MetaDataGroup	setMetaDataTypes(List<? extends MetaDataType<? extends MetaData<?>>> types)
MetaDataGroup	setTitle(String title)

Methods inherited from class java.lang.Object

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

Method Details

createGroup

public static MetaDataGroup createGroup(String title,
 URL icon)

createGroup

public static MetaDataGroup createGroup(String ID,
 String title,
 URL icon)

addMetaDataType

public MetaDataGroup addMetaDataType(MetaDataType<? extends MetaData<?>> type)

addMetaDataTypes

public MetaDataGroup addMetaDataTypes(List<? extends MetaDataType<? extends MetaData<?>>> types)

addSeparator

public MetaDataGroup addSeparator()

Adds a small gap between the last added meta data type and the next added meta data type. This can be useful to separate different meta data in the same group to make the group's layout feel more "roomy" and less cluttered.

Returns:

A new MetaDataGroup with all of this group's properties and a new separator. (This class is immutable which is why a new group is returned.)

setMetaDataTypes

public MetaDataGroup setMetaDataTypes(List<? extends MetaDataType<? extends MetaData<?>>> types)

setTitle

public MetaDataGroup setTitle(String title)

setIcon

public MetaDataGroup setIcon(URL icon)

setDefaultGroup

public MetaDataGroup setDefaultGroup(boolean defaultGroup)

getID

public String getID()

getIcon

public URL getIcon()

getTitle

public String getTitle()

getContentTypes

public List<MetaDataType<? extends MetaData<?>>> getContentTypes()

getSeparatorIndices

public List<Integer> getSeparatorIndices()

isDefaultGroup

public boolean isDefaultGroup()