Package org.ametys.web.workspace

Class WorkspaceGenerator

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.apache.cocoon.xml.AbstractXMLProducer

org.apache.cocoon.generation.AbstractGenerator

org.apache.cocoon.generation.ServiceableGenerator

org.ametys.plugins.core.ui.WorkspaceGenerator

org.ametys.web.workspace.WorkspaceGenerator

All Implemented Interfaces:

Poolable, Recyclable, Disposable, Component, LogEnabled, Serviceable, Generator, SitemapModelComponent, XMLProducer

Direct Known Subclasses:

SimpleWorkspaceGenerator

public class WorkspaceGenerator
extends WorkspaceGenerator

Generates the uitools factories definition using the associated components

Field Summary

Fields

Modifier and Type	Field	Description
protected SiteColorsComponent	_siteColors	The site colors
protected SiteManager	_siteManager	The site manager
protected SiteTypesExtensionPoint	_siteTypeExtensionPoint	The site types manager
protected String	_siteTypeName	The site
protected SkinsManager	_skinsManager	The skins manager

Fields inherited from class org.ametys.plugins.core.ui.WorkspaceGenerator

_currentUserProvider, _jsonUtils, _resolver, _ribbonControlManager, _ribbonImportManager, _ribbonManagerCache, _ribbonTabManager, _saxClientSideElementHelper, _uitoolsFactoriesManager, _userHelper, _widgetsManager

Fields inherited from class org.apache.cocoon.generation.ServiceableGenerator

manager

Fields inherited from class org.apache.cocoon.generation.AbstractGenerator

objectModel, parameters, resolver, source

Fields inherited from class org.apache.cocoon.xml.AbstractXMLProducer

contentHandler, EMPTY_CONTENT_HANDLER, lexicalHandler, xmlConsumer

Fields inherited from interface org.apache.cocoon.generation.Generator

ROLE

Constructor Summary

Constructors

Constructor	Description
WorkspaceGenerator()

Method Summary

Modifier and Type	Method	Description
void	generate()
protected Map<String,Object>	getContextualParameters()	Get the contextual parameters
protected RibbonConfigurationSource	getRibbonConfiguration()	Get the ribbon configuration
protected Source	getUIToolsConfiguration()	Get the UI tools configuration
protected void	saxAdditionnalInfo(Map<String,Object> contextParameters)	Use this method when inheriting the WorkspaceGenerator to sax additional data
void	service(ServiceManager smanager)

Methods inherited from class org.ametys.plugins.core.ui.WorkspaceGenerator

doGenerate, getElementsToSax, saxMessageTargetFactories, saxRelationsHandlers, saxStaticFileImports, saxUITools, saxWidgets

Methods inherited from class org.apache.cocoon.generation.ServiceableGenerator

dispose

Methods inherited from class org.apache.cocoon.generation.AbstractGenerator

recycle, setup

Methods inherited from class org.apache.cocoon.xml.AbstractXMLProducer

setConsumer, setContentHandler, setLexicalHandler

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.cocoon.xml.XMLProducer

setConsumer

Field Details

_siteTypeExtensionPoint

protected SiteTypesExtensionPoint _siteTypeExtensionPoint

The site types manager

_siteManager

protected SiteManager _siteManager

The site manager

_siteTypeName

protected String _siteTypeName

The site

_skinsManager

protected SkinsManager _skinsManager

The skins manager

_siteColors

protected SiteColorsComponent _siteColors

The site colors

Constructor Details

WorkspaceGenerator

public WorkspaceGenerator()

Method Details

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class WorkspaceGenerator

Throws:

ServiceException

generate

public void generate()
              throws IOException,
SAXException,
ProcessingException

Specified by:

generate in interface Generator

Overrides:

generate in class WorkspaceGenerator

Throws:

IOException

SAXException

ProcessingException

getContextualParameters

protected Map<String,Object> getContextualParameters()

Description copied from class: WorkspaceGenerator

Get the contextual parameters

Overrides:

getContextualParameters in class WorkspaceGenerator

Returns:

The contextual parameters

getRibbonConfiguration

protected RibbonConfigurationSource getRibbonConfiguration()
                                                    throws IOException

Description copied from class: WorkspaceGenerator

Get the ribbon configuration

Overrides:

getRibbonConfiguration in class WorkspaceGenerator

Returns:

the ribbon configuration

Throws:

IOException - if an errors occurs getting the ribbon configuration

getUIToolsConfiguration

protected Source getUIToolsConfiguration()
                                  throws IOException

Description copied from class: WorkspaceGenerator

Get the UI tools configuration

Overrides:

getUIToolsConfiguration in class WorkspaceGenerator

Returns:

the UI tools configuration

Throws:

IOException - if an errors occurs getting the UI tools configuration

saxAdditionnalInfo

protected void saxAdditionnalInfo(Map<String,Object> contextParameters)
                           throws SAXException

Description copied from class: WorkspaceGenerator

Use this method when inheriting the WorkspaceGenerator to sax additional data

Overrides:

saxAdditionnalInfo in class WorkspaceGenerator

Parameters:

contextParameters - the context parameters

Throws:

SAXException - if an error occurred