Group (Ametys 4.0.x

java.lang.Object
- org.ametys.core.ui.ribbonconfiguration.Group

```
public class Group
extends Object
```
A group of a tab in the ribbon

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`_controlsOrder` When overriding, defines the controls position in the original group
`protected String`	`_dialogBoxLauncher` The control to call when dialog box launcher is clicked (we exactly call the method in the param 'dialog-box-launcher')
`protected Logger`	`_groupLogger` The logger
`protected String`	`_icon` The icon of the group (in collapsed state)
`protected I18nizableText`	`_label` The label of the group
`protected RibbonElementsInjectionHelper<Element>`	`_largeOverrideHelper` Helper for controls injection
`protected GroupSize`	`_largeSize` The large version of the group
`protected RibbonElementsInjectionHelper<Element>`	`_mediumOverrideHelper` Helper for controls injection
`protected GroupSize`	`_mediumSize` The medium version of the group
`protected String`	`_order` When overriding, defines the group position inside the tab
`protected Boolean`	`_override` True to override an existing group instead of defining a new one
`protected int`	`_priority` The priority of the group (for resize purposes)
`protected RibbonElementsInjectionHelper<Element>`	`_smallOverrideHelper` Helper for controls injection
`protected GroupSize`	`_smallSize` The short version of the group

Constructor Summary

Constructors
Constructor and Description
`Group(Configuration groupConfiguration, RibbonManager ribbonManager, Logger logger)` Creates a group
`Group(Group ribbonGroup)` Create an empty group by copying another group's parameters
`Group(Logger logger)` Creates an empty group

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`private void`	`_checkSizeConsistency(Configuration groupConfiguration)`
`protected void`	`_configureLabelAndIcon(Configuration groupConfiguration)` Configure one group label
`private void`	`_configureOverride(Configuration groupConfiguration)`
`protected void`	`_configureSize(Configuration groupConfiguration, RibbonManager ribbonManager)` Configure the different size of the group
`GroupSize`	`getLargeGroupSize()` Retrieve the large group size from this group
`GroupSize`	`getMediumGroupSize()` Retrieve the medium group size from this group
`String`	`getOrder()` Return the order of the group
`GroupSize`	`getSmallGroupSize()` Retrieve the small group size from this group
`void`	`injectGroup(Group group)` Inject a group's controls into this group
`private void`	`injectGroup(Group group, RibbonElementsInjectionHelper<Element> overrideHelper, GroupSize fromSizeFirst, GroupSize fromSizeSecond, GroupSize fromSizeThird)`
`boolean`	`isEmpty()` Return true if the group does not have any controls
`boolean`	`isOverride()` Return true if the group overrides another group
`void`	`toSAX(ContentHandler handler)` Sax the the configuration of the group.
`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 group
  - _icon
```
protected String _icon
```
    The icon of the group (in collapsed state)
  - _priority
```
protected int _priority
```
    The priority of the group (for resize purposes)
  - _dialogBoxLauncher
```
protected String _dialogBoxLauncher
```
    The control to call when dialog box launcher is clicked (we exactly call the method in the param 'dialog-box-launcher')
  - _largeSize
```
protected GroupSize _largeSize
```
    The large version of the group
  - _mediumSize
```
protected GroupSize _mediumSize
```
    The medium version of the group
  - _smallSize
```
protected GroupSize _smallSize
```
    The short version of the group
  - _override
```
protected Boolean _override
```
    True to override an existing group instead of defining a new one
  - _order
```
protected String _order
```
    When overriding, defines the group position inside the tab
  - _controlsOrder
```
protected String _controlsOrder
```
    When overriding, defines the controls position in the original group
  - _largeOverrideHelper
```
protected RibbonElementsInjectionHelper<Element> _largeOverrideHelper
```
    Helper for controls injection
  - _mediumOverrideHelper
```
protected RibbonElementsInjectionHelper<Element> _mediumOverrideHelper
```
    Helper for controls injection
  - _smallOverrideHelper
```
protected RibbonElementsInjectionHelper<Element> _smallOverrideHelper
```
    Helper for controls injection
  - _groupLogger
```
protected Logger _groupLogger
```
    The logger
- Constructor Detail
  - Group
```
public Group(Configuration groupConfiguration,
             RibbonManager ribbonManager,
             Logger logger)
      throws ConfigurationException
```
    Creates a group
    
    Parameters:
    
    groupConfiguration - The configuration of the group
    
    ribbonManager - The ribbon manager
    
    logger - The logger
    
    Throws:
    
    ConfigurationException - if an error occurs in the configuration
  - Group
```
public Group(Logger logger)
```
    Creates an empty group
    
    Parameters:
    
    logger - The logger
  - Group
```
public Group(Group ribbonGroup)
```
    Create an empty group by copying another group's parameters
    
    Parameters:
    
    ribbonGroup - The ribbon group
- Method Detail
  - _configureLabelAndIcon
```
protected void _configureLabelAndIcon(Configuration groupConfiguration)
                               throws ConfigurationException
```
    Configure one group label
    
    Parameters:
    
    groupConfiguration - One group configuration
    
    Throws:
    
    ConfigurationException - if an error occurred
  - _configureSize
```
protected void _configureSize(Configuration groupConfiguration,
                              RibbonManager ribbonManager)
                       throws ConfigurationException
```
    Configure the different size of the group
    
    Parameters:
    
    groupConfiguration - One group configuration
    
    ribbonManager - The ribbon manager
    
    Throws:
    
    ConfigurationException - if an error occurred
  - _checkSizeConsistency
```
private void _checkSizeConsistency(Configuration groupConfiguration)
                            throws ConfigurationException
```
    Throws:
    
    ConfigurationException
  - _configureOverride
```
private void _configureOverride(Configuration groupConfiguration)
```
  - isEmpty
```
public boolean isEmpty()
```
    Return true if the group does not have any controls
    
    Returns:
    
    True if empty
  - getLargeGroupSize
```
public GroupSize getLargeGroupSize()
```
    Retrieve the large group size from this group
    
    Returns:
    
    The large group size. Can be null
  - getMediumGroupSize
```
public GroupSize getMediumGroupSize()
```
    Retrieve the medium group size from this group
    
    Returns:
    
    The medium group size. Can be null
  - getSmallGroupSize
```
public GroupSize getSmallGroupSize()
```
    Retrieve the small group size from this group
    
    Returns:
    
    The small group size. Can be null
  - isOverride
```
public boolean isOverride()
```
    Return true if the group overrides another group
    
    Returns:
    
    True if overrides
  - getOrder
```
public String getOrder()
```
    Return the order of the group
    
    Returns:
    
    The order
  - injectGroup
```
public void injectGroup(Group group)
```
    Inject a group's controls into this group
    
    Parameters:
    
    group - The group to inject
  - injectGroup
```
private void injectGroup(Group group,
                         RibbonElementsInjectionHelper<Element> overrideHelper,
                         GroupSize fromSizeFirst,
                         GroupSize fromSizeSecond,
                         GroupSize fromSizeThird)
```
  - toSAX
```
public void toSAX(ContentHandler handler)
           throws SAXException
```
    Sax the the configuration of the group.
    
    Parameters:
    
    handler - The content handler where to sax
    
    Throws:
    
    SAXException - if an error occurs
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Group

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

_label

_icon

_priority

_dialogBoxLauncher

_largeSize

_mediumSize

_smallSize

_override

_order

_controlsOrder

_largeOverrideHelper

_mediumOverrideHelper

_smallOverrideHelper

_groupLogger

Constructor Detail

Group

Group

Group

Method Detail

_configureLabelAndIcon

_configureSize

_checkSizeConsistency

_configureOverride

isEmpty

getLargeGroupSize

getMediumGroupSize

getSmallGroupSize

isOverride

getOrder

injectGroup

injectGroup

toSAX

toString