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

java.lang.Object
  extended by com.crystaldecisions.sdk.occa.report.definition.PictureFormat
All Implemented Interfaces:
IPictureFormat, IClone

public class PictureFormat
extends java.lang.Object
implements IPictureFormat, IClone

This object is used to crop the graphic (by cropping any or all of the four sides of the picture: the top, the bottom, the left, and/or the right). You can also add space to any of the four sides by that specifies a negative value. When possible, use the IPictureFormat interface.


Constructor Summary
PictureFormat()
           
PictureFormat(IPictureFormat 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 doControllerModification(java.lang.Object newObject)
           
 void endElement(java.lang.String eleName, java.util.Map objState)
           For internal use only.
 void enumerateMembers(IMemberVisitor visitor)
           
 int getBottomCropping()
           Returns the amount the bottom side of the graphic will be cropped.
 ControllableMixin getControllableMixin()
           
 boolean getIsPreserveAspectRatio()
           Returns the value of "IsPreserveAspectRatio"
 int getLeftCropping()
           Returns the amount the left side of the graphic will be cropped.
 int getRightCropping()
           Returns the amount the right side of the graphic will be cropped.
 int getTopCropping()
           Returns the amount the top side of the graphic will be cropped.
 boolean hasContent(java.lang.Object srcPictureFormat)
           
 boolean isDirectlyControllable()
           
 void readElement(java.lang.String eleName, java.lang.String sVal, org.xml.sax.Attributes attrs, java.util.Map objState)
           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 setBottomCropping(int bottomCropping)
           Sets the amount the bottom side of the graphic will be cropped.
 void setIsPreserveAspectRatio(boolean isPreserveAspectRatio)
           Sets the value if the picture will preserve aspect ratio or not.
 void setLeftCropping(int leftCropping)
           Sets the amount the left side of the graphic will be cropped.
 void setRightCropping(int rightCropping)
           Sets the amount the right side of the graphic will be cropped.
 void setTopCropping(int topCropping)
           Sets the amount the top side of the graphic will be cropped.
 boolean skipWritingIdenticalObject()
           For internal use only.
 void startElement(java.lang.String eleName, java.util.Map objState, org.xml.sax.Attributes attrs)
           For internal use only.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PictureFormat

public PictureFormat(IPictureFormat src)

PictureFormat

public PictureFormat()
Method Detail

clone

public java.lang.Object clone(boolean deepClone)

copyTo

public void copyTo(java.lang.Object destObject,
                   boolean deepCopy)

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.


endElement

public void endElement(java.lang.String eleName,
                       java.util.Map objState)

For internal use only.


getBottomCropping

public int getBottomCropping()
Description copied from interface: IPictureFormat

Returns the amount the bottom side of the graphic will be cropped. To add space to the bottom side of the graphic (instead of cropping space), specify a negative value.

Specified by:
getBottomCropping in interface IPictureFormat
Returns:
An int that specifies the amount the bottom side of the graphic will be cropped.

getLeftCropping

public int getLeftCropping()
Description copied from interface: IPictureFormat

Returns the amount the left side of the graphic will be cropped. To add space to the left side of the graphic (instead of cropping space), specify a negative value.

Specified by:
getLeftCropping in interface IPictureFormat
Returns:
An int that specifies the amount the left side of the graphic will be cropped.

getRightCropping

public int getRightCropping()
Description copied from interface: IPictureFormat

Returns the amount the right side of the graphic will be cropped. To add space to the right side of the graphic (instead of cropping space), specify a negative value.

Specified by:
getRightCropping in interface IPictureFormat
Returns:
An int that specifies the amount the right side of the graphic will be cropped.

getTopCropping

public int getTopCropping()
Description copied from interface: IPictureFormat

Returns the amount the top side of the graphic will be cropped. To add space to the top side of the graphic (instead of cropping space), specify a negative value.

Specified by:
getTopCropping in interface IPictureFormat
Returns:
An int that specifies the amount the top side of the graphic will be cropped.

getIsPreserveAspectRatio

public boolean getIsPreserveAspectRatio()
Description copied from interface: IPictureFormat

Returns the value of "IsPreserveAspectRatio"

Specified by:
getIsPreserveAspectRatio in interface IPictureFormat
Returns:
A boolean that specifies if the picture will preserve aspect ratio

hasContent

public boolean hasContent(java.lang.Object srcPictureFormat)

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.


save

public void save(XMLWriter writer,
                 XMLSerializationContext ctxt)
          throws java.io.IOException

For internal use only.

Throws:
java.io.IOException

save

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

For internal use only.

Throws:
java.io.IOException

saveContents

public void saveContents(XMLWriter writer,
                         XMLSerializationContext ctxt)
                  throws java.io.IOException

For internal use only.

Throws:
java.io.IOException

setBottomCropping

public void setBottomCropping(int bottomCropping)
Description copied from interface: IPictureFormat

Sets the amount the bottom side of the graphic will be cropped. To add space to the bottom side of the graphic (instead of cropping space), specify a negative value.

Specified by:
setBottomCropping in interface IPictureFormat
Parameters:
bottomCropping - An int that specifies the amount the bottom side of the graphic will be cropped.

setLeftCropping

public void setLeftCropping(int leftCropping)
Description copied from interface: IPictureFormat

Sets the amount the left side of the graphic will be cropped. To add space to the left side of the graphic (instead of cropping space), specify a negative value.

Specified by:
setLeftCropping in interface IPictureFormat
Parameters:
leftCropping - An int that specifies the amount the left side of the graphic will be cropped.

setRightCropping

public void setRightCropping(int rightCropping)
Description copied from interface: IPictureFormat

Sets the amount the right side of the graphic will be cropped. To add space to the right side of the graphic (instead of cropping space), specify a negative value.

Specified by:
setRightCropping in interface IPictureFormat
Parameters:
rightCropping - An int that specifies the amount the right side of the graphic will be cropped.

setTopCropping

public void setTopCropping(int topCropping)
Description copied from interface: IPictureFormat

Sets the amount the top side of the graphic will be cropped. To add space to the top side of the graphic (instead of cropping space), specify a negative value.

Specified by:
setTopCropping in interface IPictureFormat
Parameters:
topCropping - An int that specifies the amount the top side of the graphic will be cropped.

setIsPreserveAspectRatio

public void setIsPreserveAspectRatio(boolean isPreserveAspectRatio)
Description copied from interface: IPictureFormat

Sets the value if the picture will preserve aspect ratio or not.

Specified by:
setIsPreserveAspectRatio in interface IPictureFormat
Parameters:
isPreserveAspectRatio - An boolean that specifies the graphic will preserve aspect ratio or not.

skipWritingIdenticalObject

public boolean skipWritingIdenticalObject()

For internal use only.


startElement

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

For internal use only.


getControllableMixin

public ControllableMixin getControllableMixin()

doControllerModification

public void doControllerModification(java.lang.Object newObject)

isDirectlyControllable

public boolean isDirectlyControllable()

enumerateMembers

public void enumerateMembers(IMemberVisitor visitor)