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 java.lang.Object
A bean which contains a single format for a dynamic function, which contains of the function JSP, the container settings and the parameters.
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CmsUUID
getJspStructureId()
Returns the structure id of the JSP.java.lang.String
getMaxWidth()
Returns the maximum width.java.lang.String
getMinWidth()
Returns the minimum width.java.util.Map<java.lang.String,java.lang.String>
getParameters()
Returns the map of parameters for the JSP.java.lang.String
getType()
Gets the container type.boolean
hasNoContainerSettings()
Returns true if this format has no container settings.protected void
setDefaultParameters(java.util.Map<java.lang.String,java.lang.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.
-
-
-
Constructor Detail
-
Format
public Format(CmsUUID structureId, java.lang.String type, java.lang.String minWidth, java.lang.String maxWidth, java.util.Map<java.lang.String,java.lang.String> parameters)
Creates a new format instance.- Parameters:
structureId
- the structure id of the JSPtype
- the container typeminWidth
- the minimum widthmaxWidth
- the maximum widthparameters
- the JSP parameters
-
-
Method Detail
-
getJspStructureId
public CmsUUID getJspStructureId()
Returns the structure id of the JSP.- Returns:
- the structure id of the JSP
-
getMaxWidth
public java.lang.String getMaxWidth()
Returns the maximum width.- Returns:
- the maximum width
-
getMinWidth
public java.lang.String getMinWidth()
Returns the minimum width.- Returns:
- the minimum width
-
getParameters
public java.util.Map<java.lang.String,java.lang.String> getParameters()
Returns the map of parameters for the JSP.- Returns:
- the map of parameters for the JSP
-
getType
public java.lang.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(java.util.Map<java.lang.String,java.lang.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
-
-