com.ibm.workplace.wcm.api
Interface LibraryRichTextComponent
- All Superinterfaces:
- Document, Editable, EditableItem, EditableLibraryComponent, Hierarchical, Item, LibraryComponent, Localized, WCMApiObject, 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 value for this rich text component replacing any existing markup. |
Methods inherited from interface com.ibm.workplace.wcm.api.Editable |
addAuthors, addCategoryIds, addContributorAccessMembers, addDeleteAccessMembers, addEditAccessMembers, addEditorAccessMembers, addHistoryLogEntry, addLiveAccessMembers, addManagerAccessMembers, addMembersForAccess, addOwners, addReadAccessMembers, addUserAccessMembers, isChanged, removeAuthors, removeCategoryIds, removeContributorAccessMembers, removeDeleteAccessMembers, removeEditAccessMembers, removeEditorAccessMembers, removeLiveAccessMembers, removeManagerAccessMembers, removeMembersForAccess, removeOwners, removeReadAccessMembers, removeUserAccessMembers, setContributorAccessInheritance, setDescriptionTextProviderKey, setDescriptionTextProviderName, setEditorAccessInheritance, setInheritance, setKeywords, setManagerAccessInheritance, setPropagation, setTitleTextProviderKey, setTitleTextProviderName, setUserAccessInheritance |
Methods inherited from interface com.ibm.workplace.wcm.api.Document |
getAuthors, getCategoryIds, getContributorAccessMembers, getCreator, getDeleteAccessMembers, getDescription, getDescriptionTextProviderKey, getDescriptionTextProviderName, getEditAccessMembers, getEditorAccessMembers, getHistoryLog, getId, getInheritedContributorAccessMembers, getInheritedEditorAccessMembers, getInheritedManagerAccessMembers, getInheritedUserAccessMembers, getKeywords, getLastModifier, getLiveAccessMembers, getManagerAccessMembers, getMembersForAccess, getMembersForInheritedAccess, getOwnerLibrary, getOwners, getProject, getReadAccessMembers, getSourceWorkspace, getTitle, getTitleTextProviderKey, getTitleTextProviderName, getUserAccessMembers, getVersionCatalog, getVersionStrategy, hasDeleteAccess, hasDeleteAccess, hasEditAccess, hasEditAccess, hasLiveAccess, hasLiveAccess, hasProfile, hasProject, hasReadAccess, hasReadAccess, isContributorAccessInherited, isEditorAccessInherited, isInherited, isManagerAccessInherited, isNew, isPropagated, isUserAccessInherited, isWorkflowed |
Methods inherited from interface com.ibm.workplace.wcm.api.WorkflowedDocument |
addAdditionalViewers, addApprovers, approve, cancelDraftDocument, clearApprovers, createDraftDocument, decline, decline, getAdditionalViewers, getCurrentApprovers, getDateEnteredStage, getEffectiveDate, getExpiryDate, getGeneralDateOne, getGeneralDateTwo, getPendingWorkflowStatus, getPublishedDate, getPublishedId, getWorkflowId, getWorkflowStageId, getWorkflowStatus, hasApproverAccess, hasApproverAccess, hasDraft, isDraft, isDraftOfPublishedDocument, isExpired, isPublished, isWorkflowMovingBackward, nextWorkflowStage, nextWorkflowStage, nextWorkflowStage, previousWorkflowStage, previousWorkflowStage, 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 com.ibm.workplace.wcm.api.exceptions.OperationFailedException
Sets value for this rich text component replacing any existing markup.
Images stored on the file system of the WebSphere Portal server
can be embedded in the LibraryRichTextComponent
. Embedded
images are referenced in the HTML passed to setRichText(String)
using a standard HTML img tag, the value of the src attribute of the img
tag must be the absolute path to the image on the WebSphere Portal
server's file system.
Example code:
// Set HTML with embedded image
String embeddedImage = "<img src='/home/ibm/ibm.jpg' />";
lrtComponent.setRichText(embeddedImage);
- Parameters:
richText
- the rich text (HTML)
- Throws:
com.ibm.workplace.wcm.api.exceptions.OperationFailedException
- if the rich text could not be set
java.lang.NullPointerException
- if the argument to this method is null