net.sourceforge.openutils.mgnlcontrols.dialog

Class ConfigurableFreemarkerDialog

java.lang.Object

info.magnolia.cms.gui.dialog.DialogControlImpl

info.magnolia.cms.gui.dialog.DialogBox

net.sourceforge.openutils.mgnlcontrols.dialog.ConfigurableFreemarkerDialog

All Implemented Interfaces:

info.magnolia.cms.gui.dialog.DialogControl

Direct Known Subclasses:

DialogGrid

public abstract class ConfigurableFreemarkerDialog
extends info.magnolia.cms.gui.dialog.DialogBox

* A Magnolia dialog that renders by a freemarker template. There are two main properties for the dialog:

path (required)	Path to freemarker template: will be loaded from classpath or from filesystem
multiple	true / false. This property gives support to multiple field values storage.

The dialog passes some parameters to freemarker template:

name	Dialog / field name
value	Field value (multiple = false)
values	field values (multiple = true)
request	current HttpServletRequest
configuration	Map of dialog configuration. This allows to pass to template complex dialog configuration. Eg. -+ Dialog node |-- property 1 = value 1 |-+ subnode1 | |-- property 11 = value 11 | |-- property 12 = value 12 | |-+ subnode 11 | |-- property 111 = value 111 | |-- property 2 = value 2 The map will contain: configuration = Map { "property1" = "value1", "subnode1" = Map { "property11" = "value11", "property12" = "value12", "subnode11" = Map { "property111" = "value111" } }, "property2" = "value2" }

Similar to DialogFreemarker but with a fixed template, needed till MAGNOLIA-2175 is done

Version:

$Id: ConfigurableFreemarkerDialog.java 3752 2012-03-10 09:00:25Z fgiust $

Author:

fgiust

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,Object>	configuration Map of dialog configuration.
protected org.slf4j.Logger	log Logger.
protected String	uuid Configuration node UUID.

Fields inherited from class info.magnolia.cms.gui.dialog.DialogBox

BOXTYPE_1COL, BOXTYPE_2COLS

Fields inherited from class info.magnolia.cms.gui.dialog.DialogControlImpl

DEFAULT_VALUE_PROPERTY, SESSION_ATTRIBUTENAME_DIALOGOBJECT, SESSION_ATTRIBUTENAME_DIALOGOBJECT_REMOVE, VALIDATION_PATTERN_PROPERTY, value

Constructor Summary

Constructors

Constructor and Description
ConfigurableFreemarkerDialog()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addToParameters(Map<String,Object> parameters) Can be implemented by subclasses in order to add parameters to the Map passed to freemarker.
void	drawHtml(Writer out)
protected abstract String	getPath()
protected Map<String,Object>	getSubNodes(info.magnolia.cms.core.Content node) Get a recursive map view of a content node
void	init(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, info.magnolia.cms.core.Content websiteNode, info.magnolia.cms.core.Content configNode)

Methods inherited from class info.magnolia.cms.gui.dialog.DialogBox

drawHtmlPost, drawHtmlPre, getBoxType, getHtmlDescription, setBoxType

Methods inherited from class info.magnolia.cms.gui.dialog.DialogControlImpl

addOption, addSub, clearWebsiteNode, drawHtmlPostSubs, drawHtmlPreSubs, drawSubs, getConfigValue, getConfigValue, getDescription, getId, getLabel, getMessage, getMessage, getMessages, getName, getOptions, getParent, getRequest, getResponse, getStorageNode, getSub, getSubs, getTopParent, getValidationPattern, getValue, getValues, getWebsiteNode, isRequired, readValue, readValues, removeSessionAttribute, setConfig, setConfig, setConfig, setDescription, setLabel, setName, setOptions, setRequired, setSaveInfo, setSessionAttribute, setTopParent, setValidationMessage, setValue, validate

Methods inherited from class java.lang.Object

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

Field Detail

log

protected org.slf4j.Logger log

Logger.

configuration

protected Map<String,Object> configuration

Map of dialog configuration.

uuid

protected String uuid

Configuration node UUID.

Constructor Detail

ConfigurableFreemarkerDialog

public ConfigurableFreemarkerDialog()

Method Detail

getSubNodes

protected Map<String,Object> getSubNodes(info.magnolia.cms.core.Content node)
                                  throws javax.jcr.RepositoryException,
                                         info.magnolia.cms.security.AccessDeniedException

Get a recursive map view of a content node

Parameters:

node - content node

Returns:

recursive map view on content node properties and children

Throws:

javax.jcr.RepositoryException - for any exception occurred while accessing the repository

info.magnolia.cms.security.AccessDeniedException - if the current user can't read the configuration subnodes

init

public void init(javax.servlet.http.HttpServletRequest request,
        javax.servlet.http.HttpServletResponse response,
        info.magnolia.cms.core.Content websiteNode,
        info.magnolia.cms.core.Content configNode)
          throws javax.jcr.RepositoryException

Specified by:

init in interface info.magnolia.cms.gui.dialog.DialogControl

Overrides:

init in class info.magnolia.cms.gui.dialog.DialogControlImpl

Throws:

javax.jcr.RepositoryException

drawHtml

public void drawHtml(Writer out)
              throws IOException

Specified by:

drawHtml in interface info.magnolia.cms.gui.dialog.DialogControl

Overrides:

drawHtml in class info.magnolia.cms.gui.dialog.DialogControlImpl

Throws:

IOException

addToParameters

protected void addToParameters(Map<String,Object> parameters)

Can be implemented by subclasses in order to add parameters to the Map passed to freemarker.

Parameters:

parameters - parameter map

getPath

protected abstract String getPath()

Returns:

ftl template path