org.ametys.core.ui.ribbonconfiguration

Class Tab

java.lang.Object

org.ametys.core.ui.ribbonconfiguration.Tab

public class Tab
extends Object

A tab of the ribbon

Field Summary

Fields

Modifier and Type	Field and Description
protected String	_contextualColor The color (between 1 and 6) for a contextual tab
protected String	_contextualGroup The id of the contextual group (can be null for single contextual tab)
protected I18nizableText	_contextualLabel The label of the contextual group
protected String	_controlId The optional id of the contextual client side element determining the state of the ribbon
protected List<Group>	_groups The list of groups in the tab
protected I18nizableText	_label The label of the tab
protected Logger	_log Logger
protected Object	_order The tab order
protected Boolean	_orderBefore True to order before a tab specified by _order
protected Boolean	_override True to override an existing tab instead of defining a new one
protected RibbonElementsInjectionHelper<Group>	_tabOverrideHelper helper for group injection

Constructor Summary

Constructors

Constructor and Description
Tab(Configuration tabConfiguration, RibbonManager ribbonManager, Integer defaultOrder, Logger logger) Creates a tab

Method Summary

Modifier and Type	Method and Description
protected void	_configureGroups(Configuration tabConfiguration, RibbonManager ribbonManager) Configure tabs groups
protected void	_configureId(Configuration tabConfiguration) Configure tab optional id
private void	_configureOrder(Configuration tabConfiguration, Integer defaultOrder)
protected void	_generateTabControl(Configuration tabConfiguration, RibbonManager ribbonManager) Generate a new tab control on the fly
List<Group>	getGroups() Retrieve the list of configured groups
String	getId() Get the id of this tab;
String	getLabel() Get the tab label
Integer	getOrderAsInteger() Get the order attribute of the tab
String	getOrderAsString() Get the order attribute of the tab
void	injectGroups(List<Group> groups) Inject a list of groups into this tab
void	injectGroupsOverride(List<Group> groups) Inject a list of overriding groups into this tab
Boolean	isContextual() Return true if the tab is contextual
boolean	isOverride() Return true if this tab overrides an existing tab
boolean	orderBefore() True if the tab should be ordered before the tab referenced by the attribute order
void	saxGroups(ContentHandler handler, List<Group> groups) Sax the configuration of the tab.
void	setOrder(Object order) Set the order attribute of the tab
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

_label

protected I18nizableText _label

The label of the tab

_controlId

protected String _controlId

The optional id of the contextual client side element determining the state of the ribbon

_contextualColor

protected String _contextualColor

The color (between 1 and 6) for a contextual tab

_contextualGroup

protected String _contextualGroup

The id of the contextual group (can be null for single contextual tab)

_contextualLabel

protected I18nizableText _contextualLabel

The label of the contextual group

_order

protected Object _order

The tab order

_orderBefore

protected Boolean _orderBefore

True to order before a tab specified by _order

_override

protected Boolean _override

True to override an existing tab instead of defining a new one

_groups

protected List<Group> _groups

The list of groups in the tab

_tabOverrideHelper

protected RibbonElementsInjectionHelper<Group> _tabOverrideHelper

helper for group injection

_log

protected Logger _log

Logger

Constructor Detail

Tab

public Tab(Configuration tabConfiguration,
           RibbonManager ribbonManager,
           Integer defaultOrder,
           Logger logger)
    throws ConfigurationException

Creates a tab

Parameters:

tabConfiguration - The configuration of the tab

ribbonManager - The ribbon manager

defaultOrder - The default tab order, if not specified. Can be null

logger - The logger

Throws:

ConfigurationException - if an error occurs in the configuration

Method Detail

getId

public String getId()

Get the id of this tab;

Returns:

the id

isContextual

public Boolean isContextual()

Return true if the tab is contextual

Returns:

true if the tab is contextual

_configureId

protected void _configureId(Configuration tabConfiguration)
                     throws ConfigurationException

Configure tab optional id

Parameters:

tabConfiguration - One tab configuration

Throws:

ConfigurationException - if an error occurred

_generateTabControl

protected void _generateTabControl(Configuration tabConfiguration,
                                   RibbonManager ribbonManager)
                            throws ConfigurationException

Generate a new tab control on the fly

Parameters:

tabConfiguration - The tab configuration

ribbonManager - The ribbon manager

Throws:

ConfigurationException - If an error occurs

_configureGroups

protected void _configureGroups(Configuration tabConfiguration,
                                RibbonManager ribbonManager)
                         throws ConfigurationException

Configure tabs groups

Parameters:

tabConfiguration - One tab configuration

ribbonManager - The ribbon manager

Throws:

ConfigurationException - if an error occurred

_configureOrder

private void _configureOrder(Configuration tabConfiguration,
                             Integer defaultOrder)

getLabel

public String getLabel()

Get the tab label

Returns:

Return the tab label

getOrderAsString

public String getOrderAsString()

Get the order attribute of the tab

Returns:

Return the order as a String, or null

getOrderAsInteger

public Integer getOrderAsInteger()

Get the order attribute of the tab

Returns:

Return the order as an Integer, or null

setOrder

public void setOrder(Object order)

Set the order attribute of the tab

Parameters:

order - The new order value, either a String or an Integer

orderBefore

public boolean orderBefore()

True if the tab should be ordered before the tab referenced by the attribute order

Returns:

True if the tab should be ordered before the tab referenced by the attribute order

getGroups

public List<Group> getGroups()

Retrieve the list of configured groups

Returns:

The list of groups

isOverride

public boolean isOverride()

Return true if this tab overrides an existing tab

Returns:

True if overrides

injectGroups

public void injectGroups(List<Group> groups)

Inject a list of groups into this tab

Parameters:

groups - The list of groups to inject

injectGroupsOverride

public void injectGroupsOverride(List<Group> groups)

Inject a list of overriding groups into this tab

Parameters:

groups - The list of groups to inject

saxGroups

public void saxGroups(ContentHandler handler,
                      List<Group> groups)
               throws SAXException

Sax the configuration of the tab.

Parameters:

handler - The content handler where to sax

groups - The list of groups to sax

Throws:

SAXException - if an error occurs

toString

public String toString()

Overrides:

toString in class Object