Package org.ametys.core.ui.ribbonconfiguration

Class GroupSize

java.lang.Object

org.ametys.core.ui.ribbonconfiguration.GroupSize

public class GroupSize
extends Object

A group in a defined size

Field Summary

Fields

Modifier and Type	Field	Description
protected List<Element>	_elements	The list of elements in the group (controls or layouts)
protected Logger	_groupSizeLogger	The logger

Constructor Summary

Constructors

Constructor	Description
GroupSize(Configuration groupSizeConfiguration, RibbonManager ribbonManager, Logger logger)	Creates a group in a defined size
GroupSize(Logger logger)	Creates an empty group in a defined size

Method Summary

Modifier and Type	Method	Description
List<Element>	getChildren()	Retrieve the list of children elements in this element.
Set<String>	getControlIds()	Get a set of all referenced ids
boolean	isSame(GroupSize obj)	Test if this GroupSize contains the same elements as another GroupSize
void	toSAX(String elementName, ContentHandler handler)	Sax the the configuration of the group size.

Methods inherited from class java.lang.Object

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

Field Details

_elements

protected List<Element> _elements

The list of elements in the group (controls or layouts)

_groupSizeLogger

protected Logger _groupSizeLogger

The logger

Constructor Details

GroupSize

public GroupSize(Configuration groupSizeConfiguration,
 RibbonManager ribbonManager,
 Logger logger)
          throws ConfigurationException

Creates a group in a defined size

Parameters:

groupSizeConfiguration - The configuration for the size

ribbonManager - The ribbon manager

logger - The logger

Throws:

ConfigurationException - if an error occurred

GroupSize

public GroupSize(Logger logger)

Creates an empty group in a defined size

Parameters:

logger - The logger

Method Details

getControlIds

public Set<String> getControlIds()

Get a set of all referenced ids

Returns:

A non null set of control ids

getChildren

public List<Element> getChildren()

Retrieve the list of children elements in this element.

Returns:

The list of elements.

toSAX

public void toSAX(String elementName,
 ContentHandler handler)
           throws SAXException

Sax the the configuration of the group size.

Parameters:

elementName - The name of the surrounding element to use

handler - The content handler where to sax

Throws:

SAXException - if an error occurs

isSame

public boolean isSame(GroupSize obj)

Test if this GroupSize contains the same elements as another GroupSize

Parameters:

obj - The other GroupSize

Returns:

True if they are equals