com.alkacon.opencms.v8.list
Class CmsListConfiguration

java.lang.Object
  org.opencms.jsp.CmsJspBean
      org.opencms.jsp.CmsJspActionElement
          com.alkacon.opencms.v8.list.CmsListConfiguration

public class CmsListConfiguration
extends org.opencms.jsp.CmsJspActionElement

Creates a list configuration from an XML content that uses the list schema XSD.

Since:

7.6

Field Summary

static java.lang.String	MACRO_LINK_PREFIX The prefix of the macros used in the parameters.
static java.lang.String	NODE_LINKS Node name in the listbox XSD.
static java.lang.String	NODE_MAPPING Node name in the listbox XSD.
static java.lang.String	NODE_PARAMETER Node name in the listbox XSD.
static java.lang.String	PARAM_FILE Name of the parameter with the path to the resource.

Fields inherited from class org.opencms.jsp.CmsJspActionElement

NOT_INITIALIZED

Constructor Summary

CmsListConfiguration()
Empty constructor, required for every JavaBean.

CmsListConfiguration(javax.servlet.jsp.PageContext context, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
Constructor, with parameters.

CmsListConfiguration(javax.servlet.jsp.PageContext context, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, java.lang.String configPath)
Constructor, with parameters.

Method Summary

java.util.Map<java.lang.Object,CmsListEntry>	getMappedEntry() Returns a lazy initialized map with the mapped entries of the collected resources.
protected CmsListContentMapping	getMapping() Returns the mapping of the xml content to the list box entries.
java.lang.String	getParameter() Returns the parameters of the collector with resolved macros.
void	init(javax.servlet.jsp.PageContext context, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, java.lang.String configPath) Initializes the list configuration.

Methods inherited from class org.opencms.jsp.CmsJspActionElement

editable, editable, editable, editableManualClose, editableManualOpen, getContent, getContent, getMessages, getMessages, getMessages, getMessages, getNavigation, getNavigationUri, img, img, include, include, include, include, include, include, includeSilent, includeSilent, includeSilent, includeSilent, info, label, link, link, properties, properties, property, property, property, property, template, template, template, toAbsolute, user

Methods inherited from class org.opencms.jsp.CmsJspBean

getCmsObject, getController, getJspContext, getMessage, getRequest, getRequestContext, getResponse, handleException, init, isNotInitialized, isSupressingExceptions, setContentType, setStatus, setSupressingExceptions

Methods inherited from class java.lang.Object

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

Field Detail

MACRO_LINK_PREFIX

public static final java.lang.String MACRO_LINK_PREFIX

The prefix of the macros used in the parameters.

See Also:

Constant Field Values

NODE_LINKS

public static final java.lang.String NODE_LINKS

Node name in the listbox XSD.

See Also:

Constant Field Values

NODE_MAPPING

public static final java.lang.String NODE_MAPPING

Node name in the listbox XSD.

See Also:

Constant Field Values

NODE_PARAMETER

public static final java.lang.String NODE_PARAMETER

Node name in the listbox XSD.

See Also:

Constant Field Values

PARAM_FILE

public static final java.lang.String PARAM_FILE

Name of the parameter with the path to the resource.

See Also:

Constant Field Values

Constructor Detail

CmsListConfiguration

public CmsListConfiguration()

Empty constructor, required for every JavaBean.

CmsListConfiguration

public CmsListConfiguration(javax.servlet.jsp.PageContext context,
                            javax.servlet.http.HttpServletRequest req,
                            javax.servlet.http.HttpServletResponse res)

Constructor, with parameters.

Use this constructor for the template.

Parameters:

context - the JSP page context object

req - the JSP request

res - the JSP response

CmsListConfiguration

public CmsListConfiguration(javax.servlet.jsp.PageContext context,
                            javax.servlet.http.HttpServletRequest req,
                            javax.servlet.http.HttpServletResponse res,
                            java.lang.String configPath)

Constructor, with parameters.

Use this constructor for the template.

Parameters:

context - the JSP page context object

req - the JSP request

res - the JSP response

configPath - the VFS path to the list configuration

Method Detail

getMappedEntry

public java.util.Map<java.lang.Object,CmsListEntry> getMappedEntry()

Returns a lazy initialized map with the mapped entries of the collected resources.

Returns:

a lazy initialized map

getParameter

public java.lang.String getParameter()

Returns the parameters of the collector with resolved macros.

Returns:

the parameters of the collector with resolved macros

init

public void init(javax.servlet.jsp.PageContext context,
                 javax.servlet.http.HttpServletRequest req,
                 javax.servlet.http.HttpServletResponse res,
                 java.lang.String configPath)

Initializes the list configuration.

Parameters:

context - the JSP page context object

req - the JSP request

res - the JSP response

configPath - the VFS path to the list configuration

See Also:

CmsJspBean.init(javax.servlet.jsp.PageContext, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

getMapping

protected CmsListContentMapping getMapping()

Returns the mapping of the xml content to the list box entries.

Returns:

the mapping of the xml content to the list box entries