+

Search Tips | Advanced Search

com.ibm.workplace.wcm.api
Interface LibraryImageComponent

All Superinterfaces:

Document, Editable, EditableLibraryComponent, LibraryComponent, WorkflowedDocument

public interface LibraryImageComponent
extends EditableLibraryComponent

Represents an Image component that exists in the Component Library.

A ImageComponent is a ContentComponent and cannot be stored as a separate entity in the repository.

A LibraryImageComponent can contain one image. The contents of the image file are dealt with as raw byte content. This interface provides methods to manipulate the image file and the attributes to use when displaying the image.

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	getAltText() Returns the alternate text for the image.
java.lang.String	getBorder() Returns the border attribute of the image.
java.lang.String	getHeight() Returns the height of the image.
java.lang.String	getHTMLNameTag() Returns the HTML tag name of the image.
byte[]	getImage() Deprecated. use getImageStream() instead
java.lang.String	getImageFileName() Returns the filename of the image file contained within this component.
java.io.InputStream	getImageStream() Returns the contents of the image file contained within this component as a input stream
long	getSize() Returns the size in bytes of the file contained within this component.
java.lang.String	getWidth() Returns the width of the image.
void	removeImage() Removes the image file contained within this component.
void	setAltText(java.lang.String altText) Sets the alternate text of the image.
void	setBorder(java.lang.String border) Sets the image border.
void	setHeight(java.lang.String height) Sets the image height.
void	setHTMLNameTag(java.lang.String name) Sets the HTML tag name of the image.
void	setImage(java.lang.String imageFileName, byte[] image) Sets the image file contained within this component.
void	setImage(java.lang.String imageFileName, java.io.File image) Sets the image file contained within this component.
void	setWidth(java.lang.String width) Sets the width of the image.

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

Method Detail

getImage

 byte[] getImage()
                throws AuthorizationException,
                       PropertyRetrievalException

Deprecated. use getImageStream() instead

Returns the contents of the image file contained within this component as a byte array.

Returns an empty byte array if an image file has not been specified or the byte content could not be retrieved.

Returns:

the image file content as a byte array

Throws:

AuthorizationException - if the user does not have access to the image

PropertyRetrievalException - if the image cannot be retrieved

getImageStream

 java.io.InputStream getImageStream()
                                   throws AuthorizationException,
                                          PropertyRetrievalException

Returns the contents of the image file contained within this component as a input stream

Returns an empty byte array if an image file has not been specified or the byte content could not be retrieved.

Returns:

the image file content as a input stream

Throws:

AuthorizationException - if the user does not have access to the image

PropertyRetrievalException - if the image cannot be retrieved

getImageFileName

 java.lang.String getImageFileName()
                                  throws AuthorizationException,
                                         PropertyRetrievalException

Returns the filename of the image file contained within this component.

Returns null if an image file has not been set.

Returns:

the filename of the image

Throws:

AuthorizationException - if the user does not have access to the image

PropertyRetrievalException - if the image cannot be retrieved

setImage

 void setImage(java.lang.String imageFileName,
              byte[] image)
              throws OperationFailedException

Sets the image file contained within this component.

This method does not accept null arguments. Passing a null argument into this method will result in a NullPointerException.

Parameters:

imageFileName - the filename of the image file

image - the content of the image file as a byte array

Throws:

java.lang.NullPointerException - if either of the arguments imageFileName or image are null

OperationFailedException - if the image file could not be set

setImage

 void setImage(java.lang.String imageFileName,
              java.io.File image)
              throws OperationFailedException

Sets the image file contained within this component.

This method does not accept null arguments. Passing a null argument into this method will result in a NullPointerException.

Parameters:

imageFileName - the filename of the image file

image - the content of the image file as a file

Throws:

java.lang.NullPointerException - if either of the arguments imageFileName or image are null

OperationFailedException - if the image file could not be set

removeImage

 void removeImage()
                 throws OperationFailedException

Removes the image file contained within this component.

Throws:

OperationFailedException - if an error occurred removing the file.

getBorder

 java.lang.String getBorder()

Returns the border attribute of the image. Returns null if a border value has not been set, otherwise the border attribute will be returned.

Returns:

the border

setBorder

 void setBorder(java.lang.String border)
               throws OperationFailedException

Sets the image border.

If the string argument passed in to this method cannot be converted to an integer, an exception is thrown.

This method will automatically convert a null argument to the string "0".

Parameters:

border - the image border

Throws:

OperationFailedException - if the string argument cannot be converted to an integer or the border could not be set to the specified value

getAltText

 java.lang.String getAltText()

Returns the alternate text for the image.

Returns null if alternate text has not been set or the alternate text value has specifically been set to null.

Returns:

the alternate text

setAltText

 void setAltText(java.lang.String altText)

Sets the alternate text of the image.

If a null argument is passed in to this method getAltText() will return null.

Parameters:

altText - the alternate text

getHTMLNameTag

 java.lang.String getHTMLNameTag()

Returns the HTML tag name of the image. Returns null if the HTML tag name has not been specified or the HTML tag name has specifically been set to null.

Returns:

the name in the image tag

setHTMLNameTag

 void setHTMLNameTag(java.lang.String name)

Sets the HTML tag name of the image.

Set the HTML tag name of the image to refer to the image using JavaScript™.

If a null argument is passed in to this method getHTMLNameTag() will return null.

Parameters:

name - the HTML tag name of the image

getWidth

 java.lang.String getWidth()

Returns the width of the image. This is the width of the image when it is displayed.

Returns null if the width has not been set or the width value has specifically been set to null.

Returns:

the image width

setWidth

 void setWidth(java.lang.String width)
              throws OperationFailedException

Sets the width of the image. This is the width of the image when it is displayed.

If the string argument passed in to this method cannot be converted to an integer, an exception is thrown.

If a null argument is passed in to this method getWidth() will return null.

Parameters:

width - the image width.

Throws:

OperationFailedException - if the string argument cannot be converted to an integer or the width could not be set to the specified value

getHeight

 java.lang.String getHeight()

Returns the height of the image. This is the height of the image when it is displayed.

Returns null if the height has not been set or the height has specifically been set to null.

Returns:

the height

setHeight

 void setHeight(java.lang.String height)
               throws OperationFailedException

Sets the image height. This is the height of the image when it is displayed.

If the string argument passed in to this method cannot be converted to an integer, an exception is thrown.

If a null argument is passed in to this method getHeight() will return null.

Parameters:

height - the image height

Throws:

OperationFailedException - if the string argument cannot be converted to an integer or the height could not be set to the specified value

getSize

 long getSize()
             throws AuthorizationException,
                    PropertyRetrievalException

Returns the size in bytes of the file contained within this component.

Returns -1 if a file has not been specified.

Returns:

the file size in bytes

Throws:

AuthorizationException - if the user does not have access to the file

PropertyRetrievalException - if the file cannot be retrieved