org.ametys.core.ui.ribbonconfiguration

Class Layout

java.lang.Object

org.ametys.core.ui.ribbonconfiguration.Layout

All Implemented Interfaces:

Element

public class Layout
extends Object
implements Element

A layout of controls

Field Summary

Fields

Modifier and Type	Field and Description
protected int	_cols Number of columns used by the control upon some layouts.
protected List<Element>	_elements The elements in the layout.
protected RibbonConfigurationManager.LAYOUTALIGN	_layoutAlign The layout alignment
protected Logger	_layoutLogger Logger
protected RibbonConfigurationManager.CONTROLSIZE	_size The size of the control

Constructor Summary

Constructors

Constructor and Description
Layout(Configuration layoutConfiguration, RibbonManager ribbonManager, Logger logger) Creates a layout of controls
Layout(int cols, RibbonConfigurationManager.CONTROLSIZE size, RibbonConfigurationManager.LAYOUTALIGN align, Logger logger) Creates a layout of controls
Layout(Layout layout, RibbonConfigurationManager.CONTROLSIZE size) Create a new layout by duplicating an existing layout

Method Summary

Modifier and Type	Method and Description
RibbonConfigurationManager.LAYOUTALIGN	getAlign() Get the alignment of the layout
List<Element>	getChildren() Retrieve the list of children elements in this element.
int	getColumns() Get the size taken by this element, in columns
RibbonConfigurationManager.CONTROLSIZE	getSize() Get the size of the layout
boolean	isSame(Element element) Test if an element is equal to another element
void	setColumns(int cols) Set the size to take by this element
void	toSAX(ContentHandler handler) Sax the the configuration of the element.

Methods inherited from class java.lang.Object

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

Field Detail

_layoutAlign

protected RibbonConfigurationManager.LAYOUTALIGN _layoutAlign

The layout alignment

_size

protected RibbonConfigurationManager.CONTROLSIZE _size

The size of the control

_cols

protected int _cols

Number of columns used by the control upon some layouts. 1 is the common and default value

_elements

protected List<Element> _elements

The elements in the layout. Can be controls or toolbars

_layoutLogger

protected Logger _layoutLogger

Logger

Constructor Detail

Layout

public Layout(Configuration layoutConfiguration,
              RibbonManager ribbonManager,
              Logger logger)
       throws ConfigurationException

Creates a layout of controls

Parameters:

layoutConfiguration - The configuration for the layout

ribbonManager - The ribbon manager

logger - The logger

Throws:

ConfigurationException - if an error occurred

Layout

public Layout(Layout layout,
              RibbonConfigurationManager.CONTROLSIZE size)

Create a new layout by duplicating an existing layout

Parameters:

layout - The original layout

size - The new layout size

Layout

public Layout(int cols,
              RibbonConfigurationManager.CONTROLSIZE size,
              RibbonConfigurationManager.LAYOUTALIGN align,
              Logger logger)

Creates a layout of controls

Parameters:

cols - The number of columns

size - The size

align - The alignment

logger - The logger

Method Detail

getSize

public RibbonConfigurationManager.CONTROLSIZE getSize()

Get the size of the layout

Returns:

The size

getAlign

public RibbonConfigurationManager.LAYOUTALIGN getAlign()

Get the alignment of the layout

Returns:

The alignment

getColumns

public int getColumns()

Description copied from interface: Element

Get the size taken by this element, in columns

Specified by:

getColumns in interface Element

Returns:

The size

setColumns

public void setColumns(int cols)

Description copied from interface: Element

Set the size to take by this element

Specified by:

setColumns in interface Element

Parameters:

cols - The size in number of columns

getChildren

public List<Element> getChildren()

Description copied from interface: Element

Retrieve the list of children elements in this element.

Specified by:

getChildren in interface Element

Returns:

The list of elements.

toSAX

public void toSAX(ContentHandler handler)
           throws SAXException

Description copied from interface: Element

Sax the the configuration of the element.

Specified by:

toSAX in interface Element

Parameters:

handler - The content handler where to sax

Throws:

SAXException - if an error occurs

isSame

public boolean isSame(Element element)

Description copied from interface: Element

Test if an element is equal to another element

Specified by:

isSame in interface Element

Parameters:

element - The element to compare to

Returns:

True if equals