Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.ibm.workplace.wcm.api
Interface LibraryImageComponent

All Superinterfaces:
Document, EditableLibraryComponent, LibraryComponent
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()
          Returns the contents of the image file contained within this component as a byte array.
 java.lang.String getImageFileName()
          Returns the filename of the image file contained within this component.
 java.lang.String getWidth()
          Returns the width of the image.
 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 setWidth(java.lang.String width)
          Sets the width of the image.
 
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, setTitle
 
Methods inherited from interface com.ibm.workplace.wcm.api.Document
getAuthors, getDeleteAccessMembers, getDescription, getEditAccessMembers, getHistoryLog, getId, getLiveAccessMembers, getModifiedDate, getName, getOwnerLibrary, getOwners, getReadAccessMembers, getTitle, hasDeleteAccess, hasDeleteAccess, hasEditAccess, hasEditAccess, hasLiveAccess, hasLiveAccess, hasReadAccess, hasReadAccess
 

Method Detail

getImage

public byte[] getImage()
                throws AuthorizationException,
                       PropertyRetrievalException
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

getImageFileName

public 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

public 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

getBorder

public 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

public 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

public 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

public 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

public 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

public 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

public 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

public 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

public 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

public 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
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD