org.ametys.cms.contenttype

Class MetadataSet

java.lang.Object

org.ametys.cms.contenttype.AbstractMetadataSetElement

org.ametys.cms.contenttype.MetadataSet

public class MetadataSet
extends AbstractMetadataSetElement

Set of metadata.

Can be recursive if there is any composite metadata.

Field Summary

Fields

Modifier and Type	Field and Description
private I18nizableText	_description
private String	_iconDecorator
private String	_iconGlyph
private boolean	_internal
private boolean	_isEdition
private I18nizableText	_label
private String	_largeIcon
private String	_mediumIcon
private String	_name
private String	_smallIcon

Constructor Summary

Constructors

Constructor and Description
MetadataSet()

Method Summary

Modifier and Type	Method and Description
I18nizableText	getDescription() Retrieves the description.
String	getIconDecorator() Retrieves the CSS class to use for decorator above the main icon
String	getIconGlyph() Retrieves the CSS class to use for glyph icon
I18nizableText	getLabel() Retrieves the label.
String	getLargeIcon() Retrieves the URL of the small icon without the context path.
String	getMediumIcon() Retrieves the URL of the small icon without the context path.
String	getName() Retrieves the name.
String	getSmallIcon() Retrieves the URL of the small icon without the context path.
boolean	isEdition() Tests if this is an edition metadata set.
boolean	isInternal() Returns true if this metadataSet is for internal use only.
void	setDescription(I18nizableText description) Set the description.
void	setEdition(boolean edition) Set the edition metadata set status.
void	setIconDecorator(String iconDecorator) Set the CSS class to use for decorator above the main icon
void	setIconGlyph(String iconGlyph) Set the CSS class to use for glyph icon
void	setInternal(boolean isInternal) Set the internal status.
void	setLabel(I18nizableText label) Set the label.
void	setLargeIcon(String largeIcon) Set the URL of the large icon.
void	setMediumIcon(String mediumIcon) Set the URL of the medium icon.
void	setName(String name) Set the name.
void	setSmallIcon(String smallIcon) Set the URL of the small icon.
String	toString()

Methods inherited from class org.ametys.cms.contenttype.AbstractMetadataSetElement

addElement, getElements, getMetadataDefinitionReference, hasMetadataDefinitionReference

Methods inherited from class java.lang.Object

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

Field Detail

_name

private String _name

_label

private I18nizableText _label

_description

private I18nizableText _description

_iconGlyph

private String _iconGlyph

_iconDecorator

private String _iconDecorator

_smallIcon

private String _smallIcon

_mediumIcon

private String _mediumIcon

_largeIcon

private String _largeIcon

_isEdition

private boolean _isEdition

_internal

private boolean _internal

Constructor Detail

MetadataSet

public MetadataSet()

Method Detail

getName

public String getName()

Retrieves the name.

Returns:

the name.

setName

public void setName(String name)

Set the name.

Parameters:

name - the name.

getLabel

public I18nizableText getLabel()

Retrieves the label.

Returns:

the label.

setLabel

public void setLabel(I18nizableText label)

Set the label.

Parameters:

label - the label.

getDescription

public I18nizableText getDescription()

Retrieves the description.

Returns:

the description.

setDescription

public void setDescription(I18nizableText description)

Set the description.

Parameters:

description - the description.

getIconGlyph

public String getIconGlyph()

Retrieves the CSS class to use for glyph icon

Returns:

the glyph name.

setIconGlyph

public void setIconGlyph(String iconGlyph)

Set the CSS class to use for glyph icon

Parameters:

iconGlyph - the glyph name.

getIconDecorator

public String getIconDecorator()

Retrieves the CSS class to use for decorator above the main icon

Returns:

the glyph name.

setIconDecorator

public void setIconDecorator(String iconDecorator)

Set the CSS class to use for decorator above the main icon

Parameters:

iconDecorator - the glyph name.

getSmallIcon

public String getSmallIcon()

Retrieves the URL of the small icon without the context path.

Returns:

the icon URL for the small image 16x16.

setSmallIcon

public void setSmallIcon(String smallIcon)

Set the URL of the small icon.

Parameters:

smallIcon - the URL of the small icon, without the context path.

getMediumIcon

public String getMediumIcon()

Retrieves the URL of the small icon without the context path.

Returns:

the icon URL for the medium sized image 32x32.

setMediumIcon

public void setMediumIcon(String mediumIcon)

Set the URL of the medium icon.

Parameters:

mediumIcon - the URL of the medium icon, without the context path.

getLargeIcon

public String getLargeIcon()

Retrieves the URL of the small icon without the context path.

Returns:

the icon URL for the large image 48x48.

setLargeIcon

public void setLargeIcon(String largeIcon)

Set the URL of the large icon.

Parameters:

largeIcon - the URL of the large icon, without the context path.

isEdition

public boolean isEdition()

Tests if this is an edition metadata set.

Returns:

true if this is an edition metadata set, false otherwise.

setEdition

public void setEdition(boolean edition)

Set the edition metadata set status.

Parameters:

edition - true if this is an edition metadata set, false otherwise.

isInternal

public boolean isInternal()

Returns true if this metadataSet is for internal use only.

Returns:

true if this metadataSet is for internal use only.

setInternal

public void setInternal(boolean isInternal)

Set the internal status.

Parameters:

isInternal - true if this metadataSet is for internal use only, false otherwise.

toString

public String toString()

Overrides:

toString in class Object