org.exoplatform.onlyoffice.webui

Class CustomizeViewPlugin

java.lang.Object

org.exoplatform.container.component.BaseComponentPlugin

org.exoplatform.services.cms.views.impl.ManageViewPlugin

org.exoplatform.onlyoffice.webui.CustomizeViewPlugin

All Implemented Interfaces:

org.exoplatform.container.component.ComponentPlugin

public class CustomizeViewPlugin
extends org.exoplatform.services.cms.views.impl.ManageViewPlugin

Customize existing view of ECMS Document Explorer. It allows to add buttons in existing tabs of Document Explorer views. Created by The eXo Platform SAS

Version:

$Id: CustomizeViewPlugin.java 00000 Mar 2, 2016 pnedonosko $

Author:

Peter Nedonosko

Field Summary

Fields

Modifier and Type	Field and Description
protected Set<String>	configuredTemplate The configured template.
protected Set<String>	configuredViews The configured views.
protected org.exoplatform.container.configuration.ConfigurationManager	cservice The cservice.
protected org.exoplatform.services.cms.impl.DMSConfiguration	dmsConfiguration The dms configuration.
protected org.exoplatform.services.jcr.ext.hierarchy.NodeHierarchyCreator	nodeHierarchyCreator The node hierarchy creator.
protected org.exoplatform.container.xml.InitParams	params The params.
protected org.exoplatform.services.jcr.RepositoryService	repositoryService The repository service.
protected org.exoplatform.services.cms.templates.TemplateService	templateService The template service.

Fields inherited from class org.exoplatform.services.cms.views.impl.ManageViewPlugin

EDITED_CONFIGURED_VIEWS, EDITED_CONFIGURED_VIEWS_TEMPLATES

Fields inherited from class org.exoplatform.container.component.BaseComponentPlugin

desc, name

Constructor Summary

Constructors

Constructor and Description

CustomizeViewPlugin(org.exoplatform.services.jcr.RepositoryService repositoryService, org.exoplatform.container.xml.InitParams params, org.exoplatform.container.configuration.ConfigurationManager cservice, org.exoplatform.services.jcr.ext.hierarchy.NodeHierarchyCreator nodeHierarchyCreator, org.exoplatform.services.cms.impl.DMSConfiguration dmsConfiguration, org.exoplatform.services.cms.templates.TemplateService templateService) Instantiates a new customize view plugin.

Method Summary

Modifier and Type	Method and Description
protected void	customizeTab(javax.jcr.Node view, String tabName, String buttons) Customize tab.
protected javax.jcr.Node	customizeView(javax.jcr.Node viewManager, String viewName, String permissions, Boolean hideExplorerPanel, String template) Customize view.
Set<String>	getConfiguredTemplates()
Set<String>	getConfiguredViews()
void	init()
protected String	mergeButtons(String buttons, Set<String> addButtons) Read all buttons from given node, in buttons property, to given string builder.

Methods inherited from class org.exoplatform.container.component.BaseComponentPlugin

getDescription, getName, setDescription, setName

Methods inherited from class java.lang.Object

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

Field Detail

params

protected final org.exoplatform.container.xml.InitParams params

The params.

repositoryService

protected final org.exoplatform.services.jcr.RepositoryService repositoryService

The repository service.

nodeHierarchyCreator

protected final org.exoplatform.services.jcr.ext.hierarchy.NodeHierarchyCreator nodeHierarchyCreator

The node hierarchy creator.

cservice

protected final org.exoplatform.container.configuration.ConfigurationManager cservice

The cservice.

dmsConfiguration

protected final org.exoplatform.services.cms.impl.DMSConfiguration dmsConfiguration

The dms configuration.

templateService

protected final org.exoplatform.services.cms.templates.TemplateService templateService

The template service.

configuredTemplate

protected final Set<String> configuredTemplate

The configured template.

configuredViews

protected final Set<String> configuredViews

The configured views.

Constructor Detail

CustomizeViewPlugin

public CustomizeViewPlugin(org.exoplatform.services.jcr.RepositoryService repositoryService,
                           org.exoplatform.container.xml.InitParams params,
                           org.exoplatform.container.configuration.ConfigurationManager cservice,
                           org.exoplatform.services.jcr.ext.hierarchy.NodeHierarchyCreator nodeHierarchyCreator,
                           org.exoplatform.services.cms.impl.DMSConfiguration dmsConfiguration,
                           org.exoplatform.services.cms.templates.TemplateService templateService)
                    throws Exception

Instantiates a new customize view plugin.

Parameters:

repositoryService - the repository service

params - the params

cservice - the cservice

nodeHierarchyCreator - the node hierarchy creator

dmsConfiguration - the dms configuration

templateService - the template service

Throws:

Exception - the exception

Method Detail

getConfiguredTemplates

public Set<String> getConfiguredTemplates()

Overrides:

getConfiguredTemplates in class org.exoplatform.services.cms.views.impl.ManageViewPlugin

getConfiguredViews

public Set<String> getConfiguredViews()

Overrides:

getConfiguredViews in class org.exoplatform.services.cms.views.impl.ManageViewPlugin

init

public void init()
          throws Exception

Overrides:

init in class org.exoplatform.services.cms.views.impl.ManageViewPlugin

Throws:

Exception

customizeView

protected javax.jcr.Node customizeView(javax.jcr.Node viewManager,
                                       String viewName,
                                       String permissions,
                                       Boolean hideExplorerPanel,
                                       String template)
                                throws Exception

Customize view.

Parameters:

viewManager - the view manager

viewName - the view name

permissions - the permissions

hideExplorerPanel - the hide explorer panel

template - the template

Returns:

the node

Throws:

Exception - the exception

customizeTab

protected void customizeTab(javax.jcr.Node view,
                            String tabName,
                            String buttons)
                     throws Exception

Customize tab.

Parameters:

view - the view

tabName - the tab name

buttons - the buttons

Throws:

Exception - the exception

mergeButtons

protected String mergeButtons(String buttons,
                              Set<String> addButtons)
                       throws javax.jcr.RepositoryException

Read all buttons from given node, in buttons property, to given string builder.

Parameters:

buttons - the buttons

addButtons - the add buttons

Returns:

the string

Throws:

javax.jcr.RepositoryException - the repository exception