|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.arsdigita.domain.DomainObject
com.arsdigita.domain.ObservableDomainObject
com.arsdigita.kernel.ACSObject
com.arsdigita.versioning.VersionedACSObject
com.arsdigita.cms.ContentItem
com.arsdigita.cms.Asset
com.arsdigita.cms.TextAsset
com.arsdigita.cms.Template
This class represents a template.
Field Summary | |
static String |
BASE_DATA_OBJECT_TYPE
|
static String |
IS_PUBLISHABLE
|
static String |
JSP_MIME_TYPE
The default mime-type for templates |
static String |
LABEL
|
static Map |
SUPPORTED_MIME_TYPES
This is a map of all mime types with the key being the string representation of the mime type (such as 'text/x-jsp') and the value being a GlobalizedMessage that is the pretty name of the mime type. |
static String |
versionId
|
static String |
XSL_MIME_TYPE
|
Fields inherited from class com.arsdigita.cms.TextAsset |
CONTENT |
Fields inherited from class com.arsdigita.cms.Asset |
DESCRIPTION, MIME_TYPE, NAME |
Fields inherited from class com.arsdigita.cms.ContentItem |
ANCESTORS, AUDITING, CHILDREN, CONTENT_SECTION, CONTENT_TYPE, DRAFT, DRAFT_VERSION, LANGUAGE, LIVE, PARENT, PENDING, VERSION, VERSIONS |
Fields inherited from class com.arsdigita.versioning.VersionedACSObject |
IS_DELETED, MASTER |
Fields inherited from class com.arsdigita.kernel.ACSObject |
CONTAINER, DEFAULT_DOMAIN_CLASS, DISPLAY_NAME, ID, OBJECT_TYPE |
Constructor Summary | |
Template()
Default constructor. |
|
Template(BigDecimal id)
Load a template with the given ID |
|
Template(com.arsdigita.persistence.DataObject obj)
Load a Template by encapsulating the given data object |
|
Template(com.arsdigita.persistence.OID oid)
Constructor. |
|
Template(String type)
Create a new Template with the given type |
Method Summary | |
String |
getBaseDataObjectType()
|
String |
getDisplayName()
Return the publically viewable name of this template |
String |
getLabel()
Get the user-readable label for the template |
String |
getPath()
Return the path for the template. |
void |
initialize()
Called from the base class ( DomainObject )
constructors. |
Boolean |
isPublishable()
Determine whether it is possible to write the items with this template to the filesystem (as static HTML files). |
void |
setLabel(String label)
|
void |
setPublishable(boolean isPublishable)
Set whether it is possible to write the items with this template to the filesystem (as static HTML files). |
void |
setPublishable(Boolean isPublishable)
Set whether it is possible to write the items with this template to the filesystem (as static HTML files). |
Methods inherited from class com.arsdigita.cms.TextAsset |
getText, readText, recordChanges, setText, writeText, writeToFile |
Methods inherited from class com.arsdigita.cms.Asset |
getDescription, getMimeType, setDescription, setMimeType |
Methods inherited from class com.arsdigita.versioning.VersionedACSObject |
applyTag, applyUniqueTag, autoPropagateMaster, getMaster, getRolledBackTo, getTransactions, getTransactions, isMaster, isRolledBack, isSubtype, permanentlyDelete, propagateMaster, recordAttributeChange, rollBackTo, rollBackTo, rollForward, save, setMaster, trackChanges |
Methods inherited from class com.arsdigita.kernel.ACSObject |
assertPrivilege, checkPrivilege, doCreateCheck, doWriteCheck, getContainer, getDefaultDomainClass, getID, getSpecificObjectType, getSpecificOID, gimmeContainer, isContainerModified, setID, setID |
Methods inherited from class com.arsdigita.domain.ObservableDomainObject |
addObserver, getObservers |
Methods inherited from class com.arsdigita.domain.DomainObject |
add, add, addToAssociation, afterDelete, clear, delete, disconnect, equals, getObjectType, getOID, getSession, hashCode, isDeleted, isDisconnected, isModified, isNew, isPropertyModified, isValid, remove, remove, remove, removeFromAssociation, save, setAssociation, setAssociation, specializeDataObject, specializeDataObject, toString |
Methods inherited from class java.lang.Object |
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final String versionId
public static final String BASE_DATA_OBJECT_TYPE
public static final String LABEL
public static final String IS_PUBLISHABLE
public static final String JSP_MIME_TYPE
public static final String XSL_MIME_TYPE
public static final Map SUPPORTED_MIME_TYPES
Constructor Detail |
public Template()
public Template(com.arsdigita.persistence.OID oid) throws com.arsdigita.domain.DataObjectNotFoundException
DataObject
is retrieved
from the persistent storage mechanism with an OID
specified by oid.
oid
- The OID
for the retrieved
DataObject
.public Template(BigDecimal id) throws com.arsdigita.domain.DataObjectNotFoundException
id
- The id
for the retrieved
DataObject
.public Template(com.arsdigita.persistence.DataObject obj)
public Template(String type)
Method Detail |
public void initialize()
ContentItem
DomainObject
)
constructors.
initialize
in class ContentItem
public String getBaseDataObjectType()
getBaseDataObjectType
in class TextAsset
public String getLabel()
public void setLabel(String label)
public String getDisplayName()
getDisplayName
in class ContentItem
public Boolean isPublishable()
public void setPublishable(Boolean isPublishable)
isPublishable
- true if the items may be written to the filesystem, false if the
template is designed for highly dynamic items which should always be
served from the database.public void setPublishable(boolean isPublishable)
isPublishable
- true if the items may be written to the filesystem, false if the
template is designed for highly dynamic items which should always be
served from the database.public String getPath()
Note that the name of the root folder of the content section where the item resides is not included in the path.
getPath
in class ContentItem
ContentItem.getPathInfo(boolean)
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |