com.crystaldecisions.sdk.occa.report.definition
Class PictureObject

java.lang.Object
  extended by com.crystaldecisions.sdk.occa.report.definition.ReportObject
      extended by com.crystaldecisions.sdk.occa.report.definition.GraphicObject
          extended by com.crystaldecisions.sdk.occa.report.definition.PictureObject
All Implemented Interfaces:
IGraphicObject, IPictureObject, IPictureSequenceObject, IReportObject, IClone

public class PictureObject
extends GraphicObject
implements IPictureObject, IPictureSequenceObject

This object is used to specify the particular graphic you wish to copy or modify in your report object. When possible, use the IPictureObject interface.


Nested Class Summary
static class PictureObject.PictureItem
          For internal use only.
 
Constructor Summary
PictureObject()
           
PictureObject(IPictureObject src)
           
 
Method Summary
 java.lang.Object clone(boolean deepClone)
           
 void copyTo(java.lang.Object destObject, boolean deepCopy)
           
 java.lang.Object createMember(java.lang.String eleName, org.xml.sax.Attributes attrs, XMLSerializationContext ctxt, java.util.Map objState, boolean[] bLoaded)
          For internal use only.
 void disconnect()
          For internal use only.
 void endElement(java.lang.String eleName, java.util.Map objState)
          For internal use only.
 java.lang.String getGraphicLocation()
           
 IConditionFormula getGraphicLocationFormula()
           Returns the formula for the graphic location.
 java.lang.String getImageKey()
           For internal use only.
 int getNPictures()
          For internal use only.
 IByteArray getNthPictureData(int pictureIndex)
          For internal use only.
 java.lang.String getNthPictureName(int pictureIndex)
          For internal use only.
 IByteArray getPictureData()
          Gets a byte array of the object's picture data.
 PictureType getPictureType()
          Gets the format of the object's picture data.
 boolean hasContent(java.lang.Object srcPictureObject)
           
 void insertPicture(int pictureIndex, java.lang.String pictureName, IByteArray pictureData)
          For internal use only.
 boolean isConnected()
          For internal use only.
 void readElement(java.lang.String eleName, java.lang.String sVal, org.xml.sax.Attributes attrs, java.util.Map objState)
          For internal use only.
 void refresh()
          For internal use only.
 void removeAllPictures()
          For internal use only.
 void removeNthPicture(int pictureIndex)
          For internal use only.
 void save(XMLWriter writer, java.lang.String sTag, XMLSerializationContext ctxt)
          For internal use only.
 void save(XMLWriter writer, XMLSerializationContext ctxt)
          For internal use only.
 void saveContents(XMLWriter writer, XMLSerializationContext ctxt)
          For internal use only.
 void setGraphicLocation(java.lang.String locationString)
           
 void setGraphicLocationFormula(IConditionFormula locationFormula)
           Sets the formula for the graphic location.
 void setNthPictureData(int pictureIndex, java.lang.String pictureName, IByteArray pictureData)
          For internal use only.
 void setPictureData(IByteArray pictureData)
          Sets the picture data.
 void setPictureType(PictureType pictureType)
          Sets the format of the picture data.
 void startElement(java.lang.String eleName, java.util.Map objState, org.xml.sax.Attributes attrs)
          For internal use only.
 
Methods inherited from class com.crystaldecisions.sdk.occa.report.definition.GraphicObject
getOriginalHeight, getOriginalWidth, getPictureFormat, getXscaling, getYscaling, setOriginalHeight, setOriginalWidth, setPictureFormat
 
Methods inherited from class com.crystaldecisions.sdk.occa.report.definition.ReportObject
getBorder, getBorderMargins, getFormat, getFormula, getHeight, getKind, getLeft, getLinkedURI, getName, getReplacementConditionFormulas, getReportPartBookmark, getSectionCode, getSectionName, getTop, getTranslatableObject, getTranslatableString, getTranslatableStringIds, getTranslatableStringLabelResourceID, getVersion, getWidth, setBorder, setFormat, setHeight, setKind, setLeft, setLinkedURI, setName, setReplacementConditionFormulas, setReportPartBookmark, setSectionCode, setSectionName, setTop, setTranslatableString, setVersion, setWidth
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.crystaldecisions.sdk.occa.report.definition.IGraphicObject
getOriginalHeight, getOriginalWidth, getPictureFormat, getXscaling, getYscaling, setOriginalHeight, setOriginalWidth, setPictureFormat
 
Methods inherited from interface com.crystaldecisions.sdk.occa.report.definition.IReportObject
getBorder, getBorderMargins, getFormat, getHeight, getKind, getLeft, getLinkedURI, getName, getReplacementConditionFormulas, getReportPartBookmark, getSectionCode, getSectionName, getTop, getWidth, setBorder, setFormat, setHeight, setLeft, setLinkedURI, setName, setReplacementConditionFormulas, setReportPartBookmark, setSectionCode, setSectionName, setTop, setWidth
 

Constructor Detail

PictureObject

public PictureObject(IPictureObject src)

PictureObject

public PictureObject()
Method Detail

clone

public java.lang.Object clone(boolean deepClone)
Overrides:
clone in class GraphicObject

copyTo

public void copyTo(java.lang.Object destObject,
                   boolean deepCopy)
Overrides:
copyTo in class GraphicObject

createMember

public java.lang.Object createMember(java.lang.String eleName,
                                     org.xml.sax.Attributes attrs,
                                     XMLSerializationContext ctxt,
                                     java.util.Map objState,
                                     boolean[] bLoaded)
For internal use only.

Overrides:
createMember in class GraphicObject

endElement

public void endElement(java.lang.String eleName,
                       java.util.Map objState)
For internal use only.

Overrides:
endElement in class GraphicObject

getPictureType

public PictureType getPictureType()
Gets the format of the object's picture data.

Specified by:
getPictureType in interface IPictureObject
Returns:
A PictureType object that specifies the file format of the picture.

getPictureData

public IByteArray getPictureData()
Gets a byte array of the object's picture data.

Specified by:
getPictureData in interface IPictureObject
Returns:
An IByteArray containing the picture.

hasContent

public boolean hasContent(java.lang.Object srcPictureObject)
Overrides:
hasContent in class GraphicObject

readElement

public void readElement(java.lang.String eleName,
                        java.lang.String sVal,
                        org.xml.sax.Attributes attrs,
                        java.util.Map objState)
For internal use only.

Overrides:
readElement in class GraphicObject

save

public void save(XMLWriter writer,
                 XMLSerializationContext ctxt)
          throws java.io.IOException
For internal use only.

Overrides:
save in class GraphicObject
Throws:
java.io.IOException

save

public void save(XMLWriter writer,
                 java.lang.String sTag,
                 XMLSerializationContext ctxt)
          throws java.io.IOException
For internal use only.

Overrides:
save in class GraphicObject
Throws:
java.io.IOException

saveContents

public void saveContents(XMLWriter writer,
                         XMLSerializationContext ctxt)
                  throws java.io.IOException
For internal use only.

Overrides:
saveContents in class GraphicObject
Throws:
java.io.IOException

setPictureType

public void setPictureType(PictureType pictureType)
Sets the format of the picture data.

Specified by:
setPictureType in interface IPictureObject
Parameters:
pictureType - the file format of the picture data

setPictureData

public void setPictureData(IByteArray pictureData)
Sets the picture data.

Specified by:
setPictureData in interface IPictureObject
Parameters:
pictureData - a byte array containing the picture's data

startElement

public void startElement(java.lang.String eleName,
                         java.util.Map objState,
                         org.xml.sax.Attributes attrs)
For internal use only.

Overrides:
startElement in class GraphicObject

getGraphicLocationFormula

public IConditionFormula getGraphicLocationFormula()
Description copied from interface: IPictureObject

Returns the formula for the graphic location.

Specified by:
getGraphicLocationFormula in interface IPictureObject
Returns:
A IConditionFormula object that specifies the formula for the graphic location.

setGraphicLocationFormula

public void setGraphicLocationFormula(IConditionFormula locationFormula)
Description copied from interface: IPictureObject

Sets the formula for the graphic location.

Specified by:
setGraphicLocationFormula in interface IPictureObject
Parameters:
locationFormula - An IConditionFormula that specifies the formula for the graphic location.

getGraphicLocation

public java.lang.String getGraphicLocation()

setGraphicLocation

public void setGraphicLocation(java.lang.String locationString)

isConnected

public boolean isConnected()
For internal use only.


disconnect

public void disconnect()
For internal use only.


refresh

public void refresh()
For internal use only.


getNPictures

public int getNPictures()
Description copied from interface: IPictureSequenceObject
For internal use only.

Specified by:
getNPictures in interface IPictureSequenceObject

getNthPictureData

public IByteArray getNthPictureData(int pictureIndex)
Description copied from interface: IPictureSequenceObject
For internal use only.

Specified by:
getNthPictureData in interface IPictureSequenceObject

setNthPictureData

public void setNthPictureData(int pictureIndex,
                              java.lang.String pictureName,
                              IByteArray pictureData)
Description copied from interface: IPictureSequenceObject
For internal use only.

Specified by:
setNthPictureData in interface IPictureSequenceObject

getNthPictureName

public java.lang.String getNthPictureName(int pictureIndex)
Description copied from interface: IPictureSequenceObject
For internal use only.

Specified by:
getNthPictureName in interface IPictureSequenceObject

insertPicture

public void insertPicture(int pictureIndex,
                          java.lang.String pictureName,
                          IByteArray pictureData)
Description copied from interface: IPictureSequenceObject
For internal use only.

Specified by:
insertPicture in interface IPictureSequenceObject

removeNthPicture

public void removeNthPicture(int pictureIndex)
Description copied from interface: IPictureSequenceObject
For internal use only.

Specified by:
removeNthPicture in interface IPictureSequenceObject

removeAllPictures

public void removeAllPictures()
Description copied from interface: IPictureSequenceObject
For internal use only.

Specified by:
removeAllPictures in interface IPictureSequenceObject

getImageKey

public java.lang.String getImageKey()

For internal use only.

Overrides:
getImageKey in class ReportObject