com.ibm.workplace.wcm.api
Interface LibraryRichTextComponent
- All Superinterfaces:
- Document, Editable, EditableLibraryComponent, LibraryComponent, WorkflowedDocument
public interface LibraryRichTextComponent
- extends EditableLibraryComponent
Represents a RichText component that exists in the Component Library.
A LibraryRichTextComponent is a LibraryComponent and
must be stored as a separate entity in the repository.
A LibraryRichTextComponent can contain formatted rich text. This interface provides
methods to retrieve and set the rich 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 |
getRichText()
Returns the rich text contained in this component as a
String representation of the HTML. |
void |
setRichText(java.lang.String richText)
Sets the rich text in the component from a String
of HTML. |
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 |
getRichText
java.lang.String getRichText()
- Returns the rich text contained in this component as a
String representation of the HTML.
- Returns:
- the rich text
setRichText
void setRichText(java.lang.String richText)
throws OperationFailedException
- Sets the rich text in the component from a String
of HTML.
Note. This method replaces any existing rich text. It does not
append to existing rich text.
- Parameters:
- richText - the rich text (HTML)
- Throws:
- OperationFailedException - if the rich text could not be set
- java.lang.NullPointerException - if the argument to this method is null