Package org.ametys.core.ui

Class RibbonConfigurationManager

java.lang.Object

org.ametys.core.ui.RibbonConfigurationManager

public class RibbonConfigurationManager
extends Object

This class handles the ribbon configuration needed for client side display.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	RibbonConfigurationManager.CONTROLSIZE	Size constants for controls
static enum	RibbonConfigurationManager.LAYOUTALIGN	Size constants for controls

Field Summary

Fields

Modifier and Type	Field	Description
protected Set<String>	_controlsReferences	The controls referenced by the ribbon
protected SourceResolver	_resolver	The excalibur source resolver
protected RibbonConfiguration	_ribbonConfig	The ribbon configuration, as read from the configuration source
protected RibbonControlsManager	_ribbonControlManager	The ribbon controls manager
protected RibbonImportManager	_ribbonImportManager	The ribbon import manager
protected RibbonManager	_ribbonManager	The ribbon control manager
protected RibbonManagerCache	_ribbonManagerCache	The ribbon manager Cache
protected RibbonTabsManager	_ribbonTabManager	The ribbon tab extension point
protected SAXClientSideElementHelper	_saxClientSideElementHelper	The sax clientside element helper
protected Set<String>	_tabsReferences	The tabs referenced by the ribbon

Constructor Summary

Constructors

Constructor	Description
RibbonConfigurationManager()

Method Summary

Modifier and Type	Method	Description
void	configure(RibbonManager ribbonManager, ClientSideElementDependenciesManager dependenciesManager, RibbonConfigurationSource config, String workspaceName)	Configure the manager after being setup, to read and load the ribbons files
List<ClientSideElement>	getControls(Map<String,Object> contextParameters)	Retrieve the list of controls referenced by the ribbon
List<ClientSideElement>	getTabs()	Retrieve the list of tabs referenced by the ribbon
Map<String,Set<String>>	saxRibbonDefinition(ContentHandler handler, Map<String,Object> contextualParameters)	Sax the the initial configuration of the ribbon.
void	setup(RibbonControlsManager ribbonControlManager, RibbonTabsManager ribbonTabManager, RibbonImportManager ribbonImportManager, SAXClientSideElementHelper saxClientSideElementHelper, SourceResolver resolver, RibbonManagerCache ribbonManagerCache)	Setup the ribbon configuration manager with the required components.

Methods inherited from class java.lang.Object

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

Field Details

_ribbonManager

protected RibbonManager _ribbonManager

The ribbon control manager

_ribbonTabManager

protected RibbonTabsManager _ribbonTabManager

The ribbon tab extension point

_saxClientSideElementHelper

protected SAXClientSideElementHelper _saxClientSideElementHelper

The sax clientside element helper

_resolver

protected SourceResolver _resolver

The excalibur source resolver

_ribbonConfig

protected RibbonConfiguration _ribbonConfig

The ribbon configuration, as read from the configuration source

_controlsReferences

protected Set<String> _controlsReferences

The controls referenced by the ribbon

_tabsReferences

protected Set<String> _tabsReferences

The tabs referenced by the ribbon

_ribbonControlManager

protected RibbonControlsManager _ribbonControlManager

The ribbon controls manager

_ribbonImportManager

protected RibbonImportManager _ribbonImportManager

The ribbon import manager

_ribbonManagerCache

protected RibbonManagerCache _ribbonManagerCache

The ribbon manager Cache

Constructor Details

RibbonConfigurationManager

public RibbonConfigurationManager()

Method Details

setup

public void setup(RibbonControlsManager ribbonControlManager,
 RibbonTabsManager ribbonTabManager,
 RibbonImportManager ribbonImportManager,
 SAXClientSideElementHelper saxClientSideElementHelper,
 SourceResolver resolver,
 RibbonManagerCache ribbonManagerCache)

Setup the ribbon configuration manager with the required components.

Parameters:

ribbonControlManager - The ribbon control manager

ribbonTabManager - the ribbon tab manager

ribbonImportManager - The ribbon import manager

saxClientSideElementHelper - the helper to SAX client side element

resolver - the excalibur source resolver

ribbonManagerCache - The ribbon manager cache helper

configure

public void configure(RibbonManager ribbonManager,
 ClientSideElementDependenciesManager dependenciesManager,
 RibbonConfigurationSource config,
 String workspaceName)

Configure the manager after being setup, to read and load the ribbons files

Parameters:

ribbonManager - The ribbon manager for this config

dependenciesManager - The dependencies manager

config - the ribbon configuration

workspaceName - The current workspace name

Throws:

RuntimeException - if an error occurred

getControls

public List<ClientSideElement> getControls(Map<String,Object> contextParameters)

Retrieve the list of controls referenced by the ribbon

Parameters:

contextParameters - Contextuals parameters transmitted by the environment.

Returns:

The list of controls

getTabs

public List<ClientSideElement> getTabs()

Retrieve the list of tabs referenced by the ribbon

Returns:

The list of tabs

saxRibbonDefinition

public Map<String,Set<String>> saxRibbonDefinition(ContentHandler handler,
 Map<String,Object> contextualParameters)
                                            throws SAXException

Sax the the initial configuration of the ribbon.

Parameters:

handler - The content handler where to sax

contextualParameters - Contextuals parameters transmitted by the environment.

Returns:

A non null map with the key "controls" that contains the controls effectively saxed, "tabs" for tabscontrols

Throws:

SAXException - if an error occurs