com.imcode.imcms.api
Class TextDocument

java.lang.Object
  com.imcode.imcms.api.Document
      com.imcode.imcms.api.TextDocument

public class TextDocument

extends Document

Nested Class Summary

static class	TextDocument.Menu
static class	TextDocument.MenuItem
static class	TextDocument.TextField

Nested classes inherited from class com.imcode.imcms.api.Document

Document.Comparator, Document.LifeCyclePhase

Field Summary

static int

TYPE_ID

Fields inherited from class com.imcode.imcms.api.Document

STATUS_NEW, STATUS_PUBLICATION_APPROVED, STATUS_PUBLICATION_DISAPPROVED

Method Summary

Image	getImage(int imageIndexInDocument)
java.util.SortedMap	getImages()
Document	getInclude(int includeIndexInDocument)
java.util.SortedMap	getIncludes()
TextDocument.Menu	getMenu(int menuIndexInDocument) Get the menu with the given index in the owner.
java.util.SortedMap	getMenus()
Template	getTemplate()
TextDocument.TextField	getTextField(int textFieldIndexInDocument)
java.util.SortedMap	getTextFields()
void	setHtmlTextField(int textFieldIndexInDocument, java.lang.String newText)
void	setImage(int imageIndex, Image image)
void	setImage(int imageIndexInDocument, java.lang.String image_src, java.lang.String image_name, int width, int heigth, int border, int v_space, int h_space, java.lang.String align, java.lang.String link_target, java.lang.String link_href, java.lang.String alt_text, java.lang.String low_src) Deprecated. Use setImage(int, Image) instead.
void	setImage(int imageIndexInDocument, java.lang.String image_src, java.lang.String image_name, int width, int heigth, int border, int v_space, int h_space, java.lang.String align, java.lang.String link_target, java.lang.String link_targetname, java.lang.String link_href, java.lang.String alt_text, java.lang.String low_src) Deprecated. Use setImage(int, Image) instead. Will be removed in 3.0.
void	setInclude(int includeIndexInDocument, TextDocument documentToBeIncluded)
void	setPlainTextField(int textFieldIndexInDocument, java.lang.String newText)
void	setTemplate(Template template)
void	setTemplate(TemplateGroup templateGroup, Template template)

Methods inherited from class com.imcode.imcms.api.Document

addCategory, addSection, equals, getActivatedDatetime, getAllRolesMappedToPermissions, getArchivedDatetime, getCategories, getCategoriesOfType, getCreatedDatetime, getCreator, getDocumentPermissionSetForUser, getHeadline, getId, getLanguage, getMenuImageURL, getMenuText, getModifiedDatetime, getPermissionSetIdForRole, getPermissionSetRestrictedOne, getPermissionSetRestrictedTwo, getPublicationEndDatetime, getPublicationStartDatetime, getPublisher, getSections, getStatus, getTarget, hashCode, isVisibleInMenusForUnauthorizedUsers, removeCategory, setActivatedDatetime, setArchivedDatetime, setCreator, setHeadline, setLanguage, setLanguage, setMenuImageURL, setMenuText, setModifiedDatetime, setPermissionSetForRole, setPermissionSetIdForRole, setPublicationEndDatetime, setPublicationStartDatetime, setPublisher, setSections, setStatus, setVisibleInMenusForUnauthorizedUsers

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

TYPE_ID

public static final int TYPE_ID

See Also:

Constant Field Values

Method Detail

getTextFields

public java.util.SortedMap getTextFields()

Returns:

A SortedMap that contains the textFileds index as keys, and instaces of TextFields as values. Only the TextFields that contains any text is returned.

getImages

public java.util.SortedMap getImages()

Returns:

A SortedMap that contains the images index as keys, and instaces of Image as values. Only the Image that has an url is returned.

getIncludes

public java.util.SortedMap getIncludes()

Returns:

A SortedMap that contains the index of the include as keys, and instaces of Document as values. Only the includes that has a document is returned.

getTextField

public TextDocument.TextField getTextField(int textFieldIndexInDocument)
                                    throws NoPermissionException

Throws:

NoPermissionException

setPlainTextField

public void setPlainTextField(int textFieldIndexInDocument,
                              java.lang.String newText)
                       throws NoPermissionException

Throws:

NoPermissionException

setHtmlTextField

public void setHtmlTextField(int textFieldIndexInDocument,
                             java.lang.String newText)
                      throws NoPermissionException

Throws:

NoPermissionException

setImage

public void setImage(int imageIndexInDocument,
                     java.lang.String image_src,
                     java.lang.String image_name,
                     int width,
                     int heigth,
                     int border,
                     int v_space,
                     int h_space,
                     java.lang.String align,
                     java.lang.String link_target,
                     java.lang.String link_targetname,
                     java.lang.String link_href,
                     java.lang.String alt_text,
                     java.lang.String low_src)
              throws NoPermissionException

Deprecated. Use setImage(int, Image) instead. Will be removed in 3.0.

Throws:

NoPermissionException

setImage

public void setImage(int imageIndexInDocument,
                     java.lang.String image_src,
                     java.lang.String image_name,
                     int width,
                     int heigth,
                     int border,
                     int v_space,
                     int h_space,
                     java.lang.String align,
                     java.lang.String link_target,
                     java.lang.String link_href,
                     java.lang.String alt_text,
                     java.lang.String low_src)
              throws NoPermissionException

Deprecated. Use setImage(int, Image) instead.

Throws:

NoPermissionException

getImage

public Image getImage(int imageIndexInDocument)
               throws NoPermissionException

Throws:

NoPermissionException

getTemplate

public Template getTemplate()

setTemplate

public void setTemplate(TemplateGroup templateGroup,
                        Template template)
                 throws NoPermissionException

Throws:

NoPermissionException

setTemplate

public void setTemplate(Template template)
                 throws NoPermissionException

Throws:

NoPermissionException

getInclude

public Document getInclude(int includeIndexInDocument)
                    throws NoPermissionException

Throws:

NoPermissionException

setInclude

public void setInclude(int includeIndexInDocument,
                       TextDocument documentToBeIncluded)
                throws NoPermissionException

Throws:

NoPermissionException

getMenu

public TextDocument.Menu getMenu(int menuIndexInDocument)
                          throws NoPermissionException

Get the menu with the given index in the owner.

Parameters:

menuIndexInDocument - the index of the menu in the owner.

Returns:

the menu with the given index in the owner.

Throws:

NoPermissionException - if you lack permission to read this owner.

getMenus

public java.util.SortedMap getMenus()

setImage

public void setImage(int imageIndex,
                     Image image)