CmsSchemaFormatterBeanWrapper

java.lang.Object
- org.opencms.xml.containerpage.CmsSchemaFormatterBeanWrapper

所有已实现的接口:

I_CmsFormatterBean
```
public class CmsSchemaFormatterBeanWrapper
extends java.lang.Object
implements I_CmsFormatterBean
```
Wrapper class for formatter beans which delegates all methods to the wrapped formatter bean except those for which we need to ask the content handler for additional data like element settings or head includes.

构造器概要

构造器
构造器和说明
`CmsSchemaFormatterBeanWrapper(CmsObject cms, I_CmsFormatterBean wrappedBean, I_CmsXmlContentHandler contentHandler, CmsResource resource)` Creates a new wrapper instance.

方法概要

方法
限定符和类型	方法和说明
`java.util.Set<java.lang.String>`	`getContainerTypes()` Returns the formatter container type.
`java.util.Set<java.lang.String>`	`getCssHeadIncludes()` Gets the CSS head includes.
`java.lang.String`	`getId()` Returns the id of this formatter.
`java.lang.String`	`getInlineCss()` Gets the inline CSS snippets.
`java.lang.String`	`getInlineJavascript()` Gets the inline JS snippets.
`java.util.List<java.lang.String>`	`getJavascriptHeadIncludes()` Gets the Javascript head includes.
`java.lang.String`	`getJspRootPath()` Returns the root path of the formatter JSP in the OpenCms VFS.
`CmsUUID`	`getJspStructureId()` Returns the structure id of the JSP resource for this formatter.
`java.lang.String`	`getLocation()` Returns the location this formatter was defined in.
`int`	`getMaxWidth()` Returns the maximum formatter width.
`int`	`getMinWidth()` Returns the minimum formatter width.
`java.lang.String`	`getNiceName()` Gets the nice name for this formatter.
`int`	`getRank()` Gets the rank.
`java.lang.String`	`getResourceTypeName()` Gets the resource type name.
`java.util.Map<java.lang.String,CmsXmlContentProperty>`	`getSettings()` Gets the defined settings.
`boolean`	`isAutoEnabled()` Returns true if the formatter is automatically enabled.
`boolean`	`isDetailFormatter()` Returns true if the formatter can be used for detail views.
`boolean`	`isFromFormatterConfigFile()` Returns true if the formatter is from a formatter configuration file.
`boolean`	`isMatchAll()` Returns true if this formatter should match all type/width combinations.
`boolean`	`isPreviewFormatter()` Indicates if this formatter is to be used as preview in the ADE gallery GUI.
`boolean`	`isSearchContent()` Returns `true` in case an XML content formatted with this formatter should be included in the online full text search.
`boolean`	`isTypeFormatter()` Returns `true` in case this formatter is based on type information.
`void`	`setJspStructureId(CmsUUID jspStructureId)` Sets the JSP structure id.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - CmsSchemaFormatterBeanWrapper
```
public CmsSchemaFormatterBeanWrapper(CmsObject cms,
                             I_CmsFormatterBean wrappedBean,
                             I_CmsXmlContentHandler contentHandler,
                             CmsResource resource)
```
    Creates a new wrapper instance.
    
    参数:
    cms - the CMS context to use
    wrappedBean - the wrapped formatter
    contentHandler - the content handler to ask for additional information
    resource - the resource which should be used to ask the content handler for additional information
- 方法详细资料
  - getContainerTypes
```
public java.util.Set<java.lang.String> getContainerTypes()
```
    从接口复制的说明: I_CmsFormatterBean
    
    Returns the formatter container type.
    If this is "*", then the formatter is a width based formatter.
    
    指定者:
    
    getContainerTypes 在接口中 I_CmsFormatterBean
    
    返回:
    the formatter container type
    另请参阅:
    I_CmsFormatterBean.getContainerTypes()
  - getCssHeadIncludes
```
public java.util.Set<java.lang.String> getCssHeadIncludes()
```
    从接口复制的说明: I_CmsFormatterBean
    
    Gets the CSS head includes.
    
    指定者:
    
    getCssHeadIncludes 在接口中 I_CmsFormatterBean
    
    返回:
    the CSS head includes
    另请参阅:
    I_CmsFormatterBean.getCssHeadIncludes()
  - getId
```
public java.lang.String getId()
```
    从接口复制的说明: I_CmsFormatterBean
    
    Returns the id of this formatter.
    This method may return null because the id is not always defined for formatters, e.g. for those formatters declared in a schema.
    
    指定者:
    
    getId 在接口中 I_CmsFormatterBean
    
    返回:
    the formatter id
    另请参阅:
    I_CmsFormatterBean.getId()
  - getInlineCss
```
public java.lang.String getInlineCss()
```
    从接口复制的说明: I_CmsFormatterBean
    
    Gets the inline CSS snippets.
    
    指定者:
    
    getInlineCss 在接口中 I_CmsFormatterBean
    
    返回:
    the inline CSS snippets
    另请参阅:
    I_CmsFormatterBean.getInlineCss()
  - getInlineJavascript
```
public java.lang.String getInlineJavascript()
```
    从接口复制的说明: I_CmsFormatterBean
    
    Gets the inline JS snippets.
    
    指定者:
    
    getInlineJavascript 在接口中 I_CmsFormatterBean
    
    返回:
    the inline JS snippets
    另请参阅:
    I_CmsFormatterBean.getInlineJavascript()
  - getJavascriptHeadIncludes
```
public java.util.List<java.lang.String> getJavascriptHeadIncludes()
```
    从接口复制的说明: I_CmsFormatterBean
    
    Gets the Javascript head includes.
    
    指定者:
    
    getJavascriptHeadIncludes 在接口中 I_CmsFormatterBean
    
    返回:
    the head includes
    另请参阅:
    I_CmsFormatterBean.getJavascriptHeadIncludes()
  - getJspRootPath
```
public java.lang.String getJspRootPath()
```
    从接口复制的说明: I_CmsFormatterBean
    
    Returns the root path of the formatter JSP in the OpenCms VFS.
    
    指定者:
    
    getJspRootPath 在接口中 I_CmsFormatterBean
    
    返回:
    the root path of the formatter JSP in the OpenCms VFS.
    另请参阅:
    I_CmsFormatterBean.getJspRootPath()
  - getJspStructureId
```
public CmsUUID getJspStructureId()
```
    从接口复制的说明: I_CmsFormatterBean
    
    Returns the structure id of the JSP resource for this formatter.
    
    指定者:
    
    getJspStructureId 在接口中 I_CmsFormatterBean
    
    返回:
    the structure id of the JSP resource for this formatter
    另请参阅:
    I_CmsFormatterBean.getJspStructureId()
  - getLocation
```
public java.lang.String getLocation()
```
    从接口复制的说明: I_CmsFormatterBean
    
    Returns the location this formatter was defined in.
    This will be an OpenCms VFS root path, either to the XML schema XSD, or the configuration file this formatter was defined in, or to the JSP that makes up this formatter.
    
    指定者:
    
    getLocation 在接口中 I_CmsFormatterBean
    
    返回:
    the location this formatter was defined in
    另请参阅:
    I_CmsFormatterBean.getLocation()
  - getMaxWidth
```
public int getMaxWidth()
```
    从接口复制的说明: I_CmsFormatterBean
    
    Returns the maximum formatter width.
    If this is not set, then Integer.MAX_VALUE is returned.
    
    指定者:
    
    getMaxWidth 在接口中 I_CmsFormatterBean
    
    返回:
    the maximum formatter width
    另请参阅:
    I_CmsFormatterBean.getMaxWidth()
  - getMinWidth
```
public int getMinWidth()
```
    从接口复制的说明: I_CmsFormatterBean
    
    Returns the minimum formatter width.
    If this is not set, then -1 is returned.
    
    指定者:
    
    getMinWidth 在接口中 I_CmsFormatterBean
    
    返回:
    the minimum formatter width
    另请参阅:
    I_CmsFormatterBean.getMinWidth()
  - getNiceName
```
public java.lang.String getNiceName()
```
    从接口复制的说明: I_CmsFormatterBean
    
    Gets the nice name for this formatter.
    
    指定者:
    
    getNiceName 在接口中 I_CmsFormatterBean
    
    返回:
    the nice name for this formatter
    另请参阅:
    I_CmsFormatterBean.getNiceName()
  - getRank
```
public int getRank()
```
    从接口复制的说明: I_CmsFormatterBean
    
    Gets the rank.
    
    指定者:
    
    getRank 在接口中 I_CmsFormatterBean
    
    返回:
    the rank
    另请参阅:
    I_CmsFormatterBean.getRank()
  - getResourceTypeName
```
public java.lang.String getResourceTypeName()
```
    从接口复制的说明: I_CmsFormatterBean
    
    Gets the resource type name.
    
    指定者:
    
    getResourceTypeName 在接口中 I_CmsFormatterBean
    
    返回:
    the resource type name
    另请参阅:
    I_CmsFormatterBean.getResourceTypeName()
  - getSettings
```
public java.util.Map<java.lang.String,CmsXmlContentProperty> getSettings()
```
    从接口复制的说明: I_CmsFormatterBean
    
    Gets the defined settings.
    
    指定者:
    
    getSettings 在接口中 I_CmsFormatterBean
    
    返回:
    the defined settings
    另请参阅:
    I_CmsFormatterBean.getSettings()
  - isAutoEnabled
```
public boolean isAutoEnabled()
```
    从接口复制的说明: I_CmsFormatterBean
    
    Returns true if the formatter is automatically enabled.
    
    指定者:
    
    isAutoEnabled 在接口中 I_CmsFormatterBean
    
    返回:
    true if the formatter is automatically enabled
    另请参阅:
    I_CmsFormatterBean.isAutoEnabled()
  - isDetailFormatter
```
public boolean isDetailFormatter()
```
    从接口复制的说明: I_CmsFormatterBean
    
    Returns true if the formatter can be used for detail views.
    
    指定者:
    
    isDetailFormatter 在接口中 I_CmsFormatterBean
    
    返回:
    true if the formatter can be used for detail views
    另请参阅:
    I_CmsFormatterBean.isDetailFormatter()
  - isFromFormatterConfigFile
```
public boolean isFromFormatterConfigFile()
```
    从接口复制的说明: I_CmsFormatterBean
    
    Returns true if the formatter is from a formatter configuration file.
    
    指定者:
    
    isFromFormatterConfigFile 在接口中 I_CmsFormatterBean
    
    返回:
    formatter f
    另请参阅:
    I_CmsFormatterBean.isFromFormatterConfigFile()
  - isMatchAll
```
public boolean isMatchAll()
```
    从接口复制的说明: I_CmsFormatterBean
    
    Returns true if this formatter should match all type/width combinations.
    
    指定者:
    
    isMatchAll 在接口中 I_CmsFormatterBean
    
    返回:
    true if this formatter should match all type/width combinations
    另请参阅:
    I_CmsFormatterBean.isMatchAll()
  - isPreviewFormatter
```
public boolean isPreviewFormatter()
```
    从接口复制的说明: I_CmsFormatterBean
    
    Indicates if this formatter is to be used as preview in the ADE gallery GUI.
    
    指定者:
    
    isPreviewFormatter 在接口中 I_CmsFormatterBean
    
    返回:
    true if this formatter is to be used as preview in the ADE gallery GUI
    另请参阅:
    I_CmsFormatterBean.isPreviewFormatter()
  - isSearchContent
```
public boolean isSearchContent()
```
    从接口复制的说明: I_CmsFormatterBean
    
    Returns true in case an XML content formatted with this formatter should be included in the online full text search.
    
    指定者:
    
    isSearchContent 在接口中 I_CmsFormatterBean
    
    返回:
    true in case an XML content formatted with this formatter should be included in the online full text search
    另请参阅:
    I_CmsFormatterBean.isSearchContent()
  - isTypeFormatter
```
public boolean isTypeFormatter()
```
    从接口复制的说明: I_CmsFormatterBean
    
    Returns true in case this formatter is based on type information.
    
    指定者:
    
    isTypeFormatter 在接口中 I_CmsFormatterBean
    
    返回:
    true in case this formatter is based on type information
    另请参阅:
    I_CmsFormatterBean.isTypeFormatter()
  - setJspStructureId
```
public void setJspStructureId(CmsUUID jspStructureId)
```
    从接口复制的说明: I_CmsFormatterBean
    
    Sets the JSP structure id.
    
    指定者:
    
    setJspStructureId 在接口中 I_CmsFormatterBean
    
    参数:
    jspStructureId - the jsp structure id
    另请参阅:
    I_CmsFormatterBean.setJspStructureId(org.opencms.util.CmsUUID)

类 CmsSchemaFormatterBeanWrapper

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

CmsSchemaFormatterBeanWrapper

方法详细资料

getContainerTypes

getCssHeadIncludes

getId

getInlineCss

getInlineJavascript

getJavascriptHeadIncludes

getJspRootPath

getJspStructureId

getLocation

getMaxWidth

getMinWidth

getNiceName

getRank

getResourceTypeName

getSettings

isAutoEnabled

isDetailFormatter

isFromFormatterConfigFile

isMatchAll

isPreviewFormatter

isSearchContent

isTypeFormatter

setJspStructureId