Class NewsWorkspaceModule
java.lang.Object
org.ametys.runtime.plugin.component.AbstractLogEnabled
org.ametys.plugins.workspaces.AbstractWorkspaceModule
org.ametys.plugins.workspaces.news.NewsWorkspaceModule
- All Implemented Interfaces:
Comparable<WorkspaceModule>
,WorkspaceModule
,LogEnabled
,PluginAware
,Contextualizable
,Serviceable
Workspaces module for news
-
Field Summary
Fields inherited from class org.ametys.plugins.workspaces.AbstractWorkspaceModule
_context, _currentUserProvider, _i18nUtils, _modulesEP, _observationManager, _pageDAO, _pluginName, _projectManager, _projectRightHelper, _resolver, _rightManager, _serviceEP, _skinsManager, _userHelper, _userManager
Fields inherited from interface org.ametys.plugins.workspaces.project.modules.WorkspaceModule
ORDER_ALERTS, ORDER_CALENDAR, ORDER_DOCUMENTS, ORDER_MEMBERS, ORDER_NEWS, ORDER_TASKS, ORDER_THREADS, ORDER_WALLCONTENT, ORDER_WIKI
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected ModifiablePage
_createModulePage
(Project project, Sitemap sitemap, String name, I18nizableText pageTitle, String skinTemplate) Create a new page if not already existsGet the set of allowed event type for the modulegetId()
Get the module IdGet the module titleGet the module nameprotected String
Returns the module page's nameprotected String
Returns the template to use for module's pageprotected I18nizableText
Returns the module page's title as i18ngetModuleRoot
(Project project, boolean create) Get the module root node for the given projectGet the module titleint
getOrder()
Get the module orderprotected void
initializeModulePage
(ModifiablePage modulePage) Initialize the module pageMethods inherited from class org.ametys.plugins.workspaces.AbstractWorkspaceModule
_deleteEvents, _deletePages, _getAmetysObject, _getDefaultXslt, _getModulePages, _internalActivateModule, _internalDeactivateModule, _internalDeleteData, _setPagesVisibility, activateModule, contextualize, deactivateModule, deleteData, getModuleUrl, initializeSitemap, service, setPluginInfo
Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled
getLogger, setLogger
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.ametys.plugins.workspaces.project.modules.WorkspaceModule
compareTo
-
Field Details
-
NEWS_MODULE_ID
The id of calendar module
-
-
Constructor Details
-
NewsWorkspaceModule
public NewsWorkspaceModule()
-
-
Method Details
-
getId
Description copied from interface:WorkspaceModule
Get the module Id- Returns:
- The module ID
-
getOrder
Description copied from interface:WorkspaceModule
Get the module order- Returns:
- the priority in menus
-
getModuleName
Description copied from interface:WorkspaceModule
Get the module name- Returns:
- the module name
-
getAllowedEventTypes
Description copied from interface:WorkspaceModule
Get the set of allowed event type for the module- Returns:
- The set of allowed event types
-
getModuleRoot
Description copied from interface:WorkspaceModule
Get the module root node for the given project- Parameters:
project
- The project containing the modulecreate
- True to create the node if it does not exists- Returns:
- The root node, or null if it does not exists and was not created
-
getModulePageName
Description copied from class:AbstractWorkspaceModule
Returns the module page's name- Specified by:
getModulePageName
in classAbstractWorkspaceModule
- Returns:
- The module page's name
-
getModuleTitle
Description copied from interface:WorkspaceModule
Get the module title- Returns:
- The title
-
getModuleDescription
Description copied from interface:WorkspaceModule
Get the module title- Returns:
- The title
-
getModulePageTitle
Description copied from class:AbstractWorkspaceModule
Returns the module page's title as i18n- Specified by:
getModulePageTitle
in classAbstractWorkspaceModule
- Returns:
- The module page's title
-
_createModulePage
protected ModifiablePage _createModulePage(Project project, Sitemap sitemap, String name, I18nizableText pageTitle, String skinTemplate) Description copied from class:AbstractWorkspaceModule
Create a new page if not already exists- Overrides:
_createModulePage
in classAbstractWorkspaceModule
- Parameters:
project
- The module projectsitemap
- The sitemap where the page will be createdname
- The page's namepageTitle
- The page's title as i18nizable textskinTemplate
- The template from the skin to apply on the page- Returns:
- the created page or
null
if page already exists
-
initializeModulePage
Description copied from class:AbstractWorkspaceModule
Initialize the module page- Specified by:
initializeModulePage
in classAbstractWorkspaceModule
- Parameters:
modulePage
- The module page
-
getModulePageTemplate
Description copied from class:AbstractWorkspaceModule
Returns the template to use for module's page- Overrides:
getModulePageTemplate
in classAbstractWorkspaceModule
- Returns:
- The template
-