com.ibm.workplace.wcm.api
Interface LibraryHTMLComponent

All Superinterfaces:

Document, EditableLibraryComponent, LibraryComponent

public interface LibraryHTMLComponent

extends EditableLibraryComponent

Represents a HTML component that exists in the Component Library.

A LibraryHTMLComponent is a LibraryComponent and must be stored as a separate entity in the repository.

A LibraryHTMLComponent can contain HTML. This interface provides methods to retrieve and set the HTML contained within this component.

See Also:

LibraryComponent

Field Summary

static java.lang.String

COPYRIGHT Copyright statement

Method Summary

java.lang.String	getHTML() Returns the HTML contained in this component as a String.
void	setHTML(java.lang.String p_html) Sets the HTML contained in this LibraryHTMLComponent from the specified p_html argument.
void	setHTML(java.lang.String p_html, EmbeddedImageMap p_images) Sets the HTML contained in this LibraryHTMLComponent from the specified p_html argument that contains embedded images.

Methods inherited from interface com.ibm.workplace.wcm.api.EditableLibraryComponent

addAuthors, addDeleteAccessMembers, addEditAccessMembers, addLiveAccessMembers, addOwners, addReadAccessMembers, isChanged, removeAuthors, removeDeleteAccessMembers, removeEditAccessMembers, removeLiveAccessMembers, removeOwners, removeReadAccessMembers, setDescription, setName

Methods inherited from interface com.ibm.workplace.wcm.api.Document

getAuthors, getDeleteAccessMembers, getDescription, getEditAccessMembers, getId, getLiveAccessMembers, getName, getOwners, getReadAccessMembers

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

Copyright statement

See Also:

Constant Field Values

Method Detail

getHTML

public java.lang.String getHTML()

Returns the HTML contained in this component as a String.

Returns an empty String if the HTML could not be retrieved.

Returns:

the HTML

setHTML

public void setHTML(java.lang.String p_html)
             throws OperationFailedException

Sets the HTML contained in this LibraryHTMLComponent from the specified p_html argument.

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.

Parameters:

p_html - the HTML

Throws:

OperationFailedException - if the string argument is null or the HTML could not be set

setHTML

public void setHTML(java.lang.String p_html,
                    EmbeddedImageMap p_images)
             throws OperationFailedException

Sets the HTML contained in this LibraryHTMLComponent from the specified p_html argument that contains 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
  libHtmlComponent.setHTML(html, embeddedImage);
 

Parameters:

p_html - the HTML

p_images - a map of URLs to images

Throws:

OperationFailedException - if the string argument is null or the HTML could not be set