com.ibm.workplace.wcm.api
Interface LibraryTextComponent
- All Superinterfaces:
- Document, Editable, EditableLibraryComponent, LibraryComponent, WorkflowedDocument
- All Known Subinterfaces:
- LibraryShortTextComponent
public interface LibraryTextComponent
- extends EditableLibraryComponent
Represents an Text component that exists in the Component Library.
A LibraryTextComponent is a LibraryComponent and
must be stored as a separate entity in the repository.
A TextComponent contains plain text of unlimited length. This interface provides
methods to retrieve and set the text contained within this component.
note: since v6.0.0, a LibraryComponent is
referred to as a "Component" in the Authoring UI.
- See Also:
- LibraryComponent
Method Summary |
java.lang.String |
getText()
Returns the text contained in this component as a String. |
void |
setText(java.lang.String text)
Sets the plain text contained in this TextComponent. |
Methods inherited from interface com.ibm.workplace.wcm.api.Document |
getAuthors, getContributorAccessMembers, getCreationDate, getDeleteAccessMembers, getDescription, getEditAccessMembers, getEditorAccessMembers, getHistoryLog, getId, getInheritedContributorAccessMembers, getInheritedEditorAccessMembers, getInheritedManagerAccessMembers, getInheritedUserAccessMembers, getLiveAccessMembers, getManagerAccessMembers, getModifiedDate, getName, getOwnerLibrary, getOwners, getReadAccessMembers, getSourceWorkspace, getTitle, getUserAccessMembers, hasDeleteAccess, hasDeleteAccess, hasEditAccess, hasEditAccess, hasLiveAccess, hasLiveAccess, hasReadAccess, hasReadAccess, isContributorAccessInherited, isEditorAccessInherited, isManagerAccessInherited, isUserAccessInherited, isWorkflowed |
Methods inherited from interface com.ibm.workplace.wcm.api.Editable |
addAuthors, addContributorAccessMembers, addDeleteAccessMembers, addEditAccessMembers, addEditorAccessMembers, addHistoryLogEntry, addLiveAccessMembers, addManagerAccessMembers, addOwners, addReadAccessMembers, addUserAccessMembers, isChanged, removeAuthors, removeContributorAccessMembers, removeDeleteAccessMembers, removeEditAccessMembers, removeEditorAccessMembers, removeLiveAccessMembers, removeManagerAccessMembers, removeOwners, removeReadAccessMembers, removeUserAccessMembers, setContributorAccessInheritance, setDescription, setEditorAccessInheritance, setManagerAccessInheritance, setName, setTitle, setUserAccessInheritance |
Methods inherited from interface com.ibm.workplace.wcm.api.Document |
getAuthors, getContributorAccessMembers, getCreationDate, getDeleteAccessMembers, getDescription, getEditAccessMembers, getEditorAccessMembers, getHistoryLog, getId, getInheritedContributorAccessMembers, getInheritedEditorAccessMembers, getInheritedManagerAccessMembers, getInheritedUserAccessMembers, getLiveAccessMembers, getManagerAccessMembers, getModifiedDate, getName, getOwnerLibrary, getOwners, getReadAccessMembers, getSourceWorkspace, getTitle, getUserAccessMembers, hasDeleteAccess, hasDeleteAccess, hasEditAccess, hasEditAccess, hasLiveAccess, hasLiveAccess, hasReadAccess, hasReadAccess, isContributorAccessInherited, isEditorAccessInherited, isManagerAccessInherited, isUserAccessInherited, isWorkflowed |
Methods inherited from interface com.ibm.workplace.wcm.api.WorkflowedDocument |
addAdditionalViewers, addApprovers, cancelDraftDocument, createDraftDocument, decline, getAdditionalViewers, getCurrentApprovers, getEffectiveDate, getExpiryDate, getGeneralDateOne, getGeneralDateTwo, getWorkflowId, getWorkflowStageId, hasApproverAccess, hasApproverAccess, hasDraft, isDraft, isExpired, isPublished, nextWorkflowStage, nextWorkflowStage, removeAdditionalViewers, removeApprovers, restartWorkflow, setEffectiveDate, setExpiryDate, setGeneralDateOne, setGeneralDateTwo, setWorkflowId, setWorkflowId |
getText
java.lang.String getText()
- Returns the text contained in this component as a String.
- Returns:
- the text
setText
void setText(java.lang.String text)
- Sets the plain text contained in this TextComponent.
- Parameters:
- text - the text