Package org.opencms.xml.containerpage

Class CmsDynamicFunctionBean.Format

java.lang.Object

org.opencms.xml.containerpage.CmsDynamicFunctionBean.Format

Enclosing class:

CmsDynamicFunctionBean

public static class CmsDynamicFunctionBean.Format
extends Object

A bean which contains a single format for a dynamic function, which contains of the function JSP, the container settings and the parameters.

Constructor Summary

Constructors

Constructor	Description
Format(CmsUUID structureId, String type, String minWidth, String maxWidth, Map<String,String> parameters)	Creates a new format instance.

Method Summary

Modifier and Type	Method	Description
CmsUUID	getJspStructureId()	Returns the structure id of the JSP.
String	getMaxWidth()	Returns the maximum width.
String	getMinWidth()	Returns the minimum width.
Map<String,String>	getParameters()	Returns the map of parameters for the JSP.
String	getType()	Gets the container type.
boolean	hasNoContainerSettings()	Returns true if this format has no container settings.
protected void	setDefaultParameters(Map<String,String> parameters)	Sets the parameters which should be used if the format has no parameters of its own.
protected void	setNoContainerSettings(boolean noContainerSettings)	Sets the flag to indicate that this format has no container settings.

Methods inherited from class java.lang.Object

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

Constructor Details

Format

public Format(CmsUUID structureId,
 String type,
 String minWidth,
 String maxWidth,
 Map<String,String> parameters)

Creates a new format instance.

Parameters:

structureId - the structure id of the JSP

type - the container type

minWidth - the minimum width

maxWidth - the maximum width

parameters - the JSP parameters

Method Details

getJspStructureId

public CmsUUID getJspStructureId()

Returns the structure id of the JSP.

Returns:

the structure id of the JSP

getMaxWidth

public String getMaxWidth()

Returns the maximum width.

Returns:

the maximum width

getMinWidth

public String getMinWidth()

Returns the minimum width.

Returns:

the minimum width

getParameters

public Map<String,String> getParameters()

Returns the map of parameters for the JSP.

Returns:

the map of parameters for the JSP

getType

public String getType()

Gets the container type.

Returns:

the container type

hasNoContainerSettings

public boolean hasNoContainerSettings()

Returns true if this format has no container settings.

Returns:

true if this format has no container settings

setDefaultParameters

protected void setDefaultParameters(Map<String,String> parameters)

Sets the parameters which should be used if the format has no parameters of its own.

Parameters:

parameters - the default parameters

setNoContainerSettings

protected void setNoContainerSettings(boolean noContainerSettings)

Sets the flag to indicate that this format has no container settings.

Parameters:

noContainerSettings - the new value for the noContainerSettings flag