|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opencms.jsp.decorator.CmsDecorationDefintion
This class defines text decoration to be made by the postprocessor.
Constructor Summary | |
CmsDecorationDefintion()
Constructor, creates a new empty CmsDecorationDefintion. |
|
CmsDecorationDefintion(java.lang.String name,
java.lang.String preText,
java.lang.String postText,
java.lang.String preTextFirst,
java.lang.String postTextFirst,
boolean markFrist,
java.lang.String configurationFile)
Constructor, creates a new CmsDecorationDefintion with given values. |
Method Summary | |
CmsDecorationBundle |
createDecorationBundle(CmsObject cms,
java.util.Locale locale)
Creates a CmsDecorationBundle of text decoration to be used by the decorator. |
java.lang.String |
getConfigurationFile()
Returns the configurationFile. |
java.lang.String |
getName()
Returns the name. |
java.lang.String |
getPostText()
Returns the postText. |
java.lang.String |
getPostTextFirst()
Returns the postTextFirst. |
java.lang.String |
getPreText()
Returns the preText. |
java.lang.String |
getPreTextFirst()
Returns the preTextFirst. |
boolean |
isMarkFirst()
Returns the markFirst flag. |
void |
setConfigurationFile(java.lang.String configurationFile)
Sets the configurationFile. |
void |
setMarkFirst(boolean markFirst)
Sets the markFirst flag. |
void |
setName(java.lang.String name)
Sets the name. |
void |
setPostText(java.lang.String postText)
Sets the postText. |
void |
setPostTextFirst(java.lang.String postTextFirst)
Sets the postTextFirst. |
void |
setPreText(java.lang.String preText)
Sets the preText. |
void |
setPreTextFirst(java.lang.String preTextFirst)
Sets the preTextFirst. |
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public CmsDecorationDefintion()
public CmsDecorationDefintion(java.lang.String name, java.lang.String preText, java.lang.String postText, java.lang.String preTextFirst, java.lang.String postTextFirst, boolean markFrist, java.lang.String configurationFile)
name
- the name of the decoration defintinionpreText
- the preText to be usedpostText
- the postText to be usedpreTextFirst
- the preTextFirst to be usedpostTextFirst
- the postTextFirst to be usedmarkFrist
- the flag to use different decorations for the first occuranceconfigurationFile
- the name of the configuration fileMethod Detail |
public CmsDecorationBundle createDecorationBundle(CmsObject cms, java.util.Locale locale) throws CmsException
cms
- the CmsObjectlocale
- the locale to build the decoration bundle for. If no locale is given, a bundle of all locales is build
CmsException
- if something goes wrongpublic java.lang.String getConfigurationFile()
public java.lang.String getName()
public java.lang.String getPostText()
public java.lang.String getPostTextFirst()
public java.lang.String getPreText()
public java.lang.String getPreTextFirst()
public boolean isMarkFirst()
public void setConfigurationFile(java.lang.String configurationFile)
configurationFile
- the configurationFile to setpublic void setMarkFirst(boolean markFirst)
markFirst
- the markFirst flag to setpublic void setName(java.lang.String name)
name
- the name to setpublic void setPostText(java.lang.String postText)
postText
- the postText to setpublic void setPostTextFirst(java.lang.String postTextFirst)
postTextFirst
- the postTextFirst to setpublic void setPreText(java.lang.String preText)
preText
- the preText to setpublic void setPreTextFirst(java.lang.String preTextFirst)
preTextFirst
- the preTextFirst to setpublic java.lang.String toString()
Object.toString()
|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |