|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface RichTextComponent
Represents a Rich Text component.
A RichTextComponent
is a ContentComponent
and
cannot be stored as a separate entity in the repository.
A RichTextComponent
can contain formatted rich text.
note: since
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 Example code:v6.0.0
, a RichTextComponent
is
referred to as an "Rich Text Element"
in the Authoring UI.
ContentComponent
Method Summary
DocumentType<? extends RichTextComponent>
getDocumentType()
Returns the DocumentType
of the ContentComponent
.
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.
void
setRichText(java.lang.String richText,
com.ibm.workplace.wcm.api.EmbeddedImageMap images)
Deprecated. This method is deprecated from version 6.0.
Use setRichText(String)
instead.
Methods inherited from interface com.ibm.workplace.wcm.api.ContentComponent
getContainer, getName, getTitleTextProviderKey, getTitleTextProviderName, setTitleTextProviderKey, setTitleTextProviderName
Method Detail
getDocumentType
DocumentType<? extends RichTextComponent> getDocumentType()
ContentComponent
DocumentType
of the ContentComponent
.
getDocumentType
in interface ContentComponent
ContentComponent.getDocumentType()
getRichText
java.lang.String getRichText()
String
representation of the HTML.
setRichText
void setRichText(java.lang.String richText)
throws com.ibm.workplace.wcm.api.exceptions.OperationFailedException
RichTextComponent
. 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.
// Set HTML with embedded image
String embeddedImage = "<img src='/home/ibm/ibm.jpg' />";
rtComponent.setRichText(embeddedImage);
richText
- the rich text (HTML)
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 nullvoid setRichText(java.lang.String richText, com.ibm.workplace.wcm.api.EmbeddedImageMap images) throws com.ibm.workplace.wcm.api.exceptions.OperationFailedException
setRichText(String)
instead.
String
of HTML and embedded images. The URL from the src
attribute of the img
tag must have a corresponding
entry in an EmbeddedImageMap
object that you add
via the addImage
method.
A WCM resource is created for the image when you save the workspace
The src
attribute in the img
tag will be
replaced by a WCM resource's url. If the same URL appears in the
HTML more than once, the same WCM resource will be used.
Note. This method replaces any existing HTML in this component. It does not append to existing HTML. Existing images will be removed, new images will be added.
Example code:
File file = new File("C:/example/image.jpg"); EmbeddedImageMap embeddedImage = new EmbeddedImageMap(); embeddedImage.addImage("c:/example/image.jpg", file); // Set HTML rteComponent.setRichText(rteText, embeddedImage);
richText
- the rich text (HTML)images
- a map of URLs to images
com.ibm.workplace.wcm.api.exceptions.OperationFailedException
- if the string argument is null
or the
HTML could not be set
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |