public class CSTemplateContent extends CSItemContent
CSTemplate
object.
CSTemplate
,
Serialized FormConstructor and Description |
---|
CSTemplateContent()
Creates an empty
CSTemplateContent object. |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj)
Determines whether the data contained in this
CSTemplateContent object is the same as that
contained within the one supplied. |
boolean |
getAllowWYSIWYGEdit()
Gets whether the template renders articles in a form suitable for use with the WYSIWYG article editor.
|
java.util.ArrayList |
getAssets()
Gets the collection of assets supported by the template.
|
java.lang.String |
getDefaultDocExt()
Gets the filename extension of this template's default document.
|
java.lang.String |
getDescription()
Gets the template's description.
|
java.lang.String |
getDeveloperHelp()
Gets the HTML stream that provides guidance to the article contributor using this template.
|
java.lang.String |
getExtensionFormName()
Gets the name of the article extension form.
|
java.lang.String |
getHint()
Gets the template hint text.
|
java.util.ArrayList |
getImages()
Gets the details of the images associated with the template.
|
int |
getImportInlineTypeID()
Gets the ID of the inline type used to embed media items back into article text after document import
if the
ImportType is set to Inline . |
int |
getImportMediaGroupID()
Gets the ID of the media group where media items extracted during document import will be created.
|
int |
getImportMediaTypeID()
Gets the ID of the media type used to define media items extracted during document import.
|
java.lang.String |
getImportPlaceholderText()
Gets the text inserted into the article body to mark the locations where media items were
extracted during document import if the
ImportType is
set to Related . |
java.lang.String |
getImportType()
Gets the type of relationship established between the article and any media items extracted from
within a document when document text is imported into articles that are based on this template.
|
java.lang.String |
getListAssetTypes()
Gets a comma-delimited list of the asset types supported by the template.
|
java.lang.String |
getName()
Gets the name of the template.
|
java.util.ArrayList |
getPreviewModes()
Gets the preview modes supported by the template.
|
java.lang.String |
getStylesheet()
Gets the filename of the stylesheet to be used when this template renders an article.
|
int |
getSubsiteID()
Gets the ID of the subsite used as key information.
|
int |
getTemplateID()
Gets the ID of the template.
|
boolean |
getTemplateInjectsWYSIWYGMarkers()
Gets whether or not the template code is responsible for injecting markers
where related content items should appear within the rendered article
when the article is being edited within iCM's WYSIWYG article editor.
|
void |
setAllowWYSIWYGEdit(boolean allowWYSIWYGEdit)
Sets whether the template renders articles in a form suitable for use with the WYSIWYG article editor.
|
void |
setAssets(java.util.ArrayList assets)
Sets the collection of assets supported by the template.
|
void |
setDefaultDocExt(java.lang.String defaultDocExt)
Sets the filename extension of this template's default document.
|
void |
setDescription(java.lang.String strDescription)
Sets the description for the template.
|
void |
setDeveloperHelp(java.lang.String htmlDeveloperHelp)
Sets the HTML used to provide assistance to contributors using this template.
|
void |
setExtensionFormName(java.lang.String strName)
Sets the name of the article extension form.
|
void |
setHint(java.lang.String hint)
Sets the template hint text.
|
void |
setImages(java.util.ArrayList images)
Sets the details of the images associated with the template.
|
void |
setImportInlineTypeID(int inlineTypeID)
Sets the ID of the inline type used to embed media items back into article text after document import
if the
ImportType is set to Inline . |
void |
setImportMediaGroupID(int mediaGroupID)
Sets the ID of the media group where media items extracted during document import will be created.
|
void |
setImportMediaTypeID(int mediaTypeID)
Sets the ID of the media type used to define media items extracted during document import.
|
void |
setImportPlaceholderText(java.lang.String placeholderText)
Sets the text inserted into the article body to mark the locations where media items were
extracted during document import if the
ImportType is
set to Related . |
void |
setImportType(java.lang.String importType)
Sets the type of relationship to be established between an article and any media items extracted from
within a document during document import.
|
void |
setName(java.lang.String strName)
Sets the name of the template.
|
void |
setPreviewModes(java.util.ArrayList previewModes)
Sets the preview modes supported by the template.
|
void |
setStylesheet(java.lang.String Stylesheet)
Sets the filename of the stylesheet to be used when this template renders an article.
|
void |
setSubsiteID(int nSubsiteID)
Sets the ID of the subsite used as key information.
|
void |
setTemplateID(int nTemplateID)
Sets the ID of the template.
|
java.lang.String |
toString()
Outputs the contents of this
CSTemplateContent object to a String object in a
user-friendly format. |
clone, getID, setID, unset
public CSTemplateContent()
CSTemplateContent
object.public void setTemplateID(int nTemplateID)
nTemplateID
- the numeric identifier of the template.public int getTemplateID()
public void setName(java.lang.String strName)
strName
- the template's name.public java.lang.String getName()
public void setDescription(java.lang.String strDescription)
strDescription
- the template's description.public java.lang.String getDescription()
public void setSubsiteID(int nSubsiteID)
nSubsiteID
- the numeric identifier of the subsite.public int getSubsiteID()
public void setExtensionFormName(java.lang.String strName)
strName
- the form name.public java.lang.String getExtensionFormName()
public java.lang.String getDefaultDocExt()
public void setDefaultDocExt(java.lang.String defaultDocExt)
defaultDocExt
- the document extension to set (without the leading '.' character).public boolean getTemplateInjectsWYSIWYGMarkers()
true
as the Java API never
injects these markers.public java.lang.String getDeveloperHelp()
public void setDeveloperHelp(java.lang.String htmlDeveloperHelp)
htmlDeveloperHelp
- the HTML help to set.public java.lang.String getHint()
public void setHint(java.lang.String hint)
hint
- the hint text to set.public java.lang.String getListAssetTypes()
public java.util.ArrayList getAssets()
public void setAssets(java.util.ArrayList assets)
assets
- the ArrayList of CSTemplateAsset
objects to setpublic boolean getAllowWYSIWYGEdit()
true
if the template renders editor compatible HTML, false
otherwise.public void setAllowWYSIWYGEdit(boolean allowWYSIWYGEdit)
allowWYSIWYGEdit
- true
if the template renders editor compatible HTML, false
otherwise.public java.lang.String getStylesheet()
public void setStylesheet(java.lang.String Stylesheet)
Stylesheet
- the stylesheet filename to setpublic java.util.ArrayList getPreviewModes()
CSTemplatePreviewMode
instances.public void setPreviewModes(java.util.ArrayList previewModes)
previewModes
- an ArrayList of CSTemplatePreviewMode
instances to set.public java.util.ArrayList getImages()
/media/templateimages@0/
folder.CSTemplateImage
instances.public void setImages(java.util.ArrayList images)
/media/templateimages@0/
folder.images
- an ArrayList of CSTemplateImage
instances to set.public java.lang.String getImportType()
Related
or Inline
.public void setImportType(java.lang.String importType)
importType
- the type of relationship. Must be either Related
or Inline
.public int getImportInlineTypeID()
ImportType
is set to Inline
.public void setImportInlineTypeID(int inlineTypeID)
ImportType
is set to Inline
.inlineTypeID
- the inline TypeID to setpublic int getImportMediaGroupID()
public void setImportMediaGroupID(int mediaGroupID)
mediaGroupID
- the media group ID to set.public int getImportMediaTypeID()
public void setImportMediaTypeID(int mediaTypeID)
mediaTypeID
- the media TypeID to setpublic java.lang.String getImportPlaceholderText()
ImportType
is
set to Related
.public void setImportPlaceholderText(java.lang.String placeholderText)
ImportType
is
set to Related
.placeholderText
- the placeholder text to set.public java.lang.String toString()
CSTemplateContent
object to a String
object in a
user-friendly format.
toString
in class CSItemContent
String
containing the user-friendly output.public boolean equals(java.lang.Object obj)
CSTemplateContent
object is the same as that
contained within the one supplied. Note that the key data used for searching is not tested for equality.
equals
in class CSItemContent
obj
- the CSTemplateContent
to be tested for equality.true
if the data matches, false
otherwise.Copyright © 2022 Goss Interactive Ltd. All Rights Reserved.