com.crystaldecisions.sdk.occa.report.definition
Interface IPictureFormat

All Superinterfaces:
IClone
All Known Implementing Classes:
PictureFormat

public interface IPictureFormat
extends IClone

This interface 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.


Method Summary
 int getBottomCropping()
           Returns the amount the bottom side of the graphic will be cropped.
 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.
 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.
 

Method Detail

getBottomCropping

int getBottomCropping()

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.

Returns:
An int that specifies the amount the bottom side of the graphic will be cropped.

getLeftCropping

int getLeftCropping()

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.

Returns:
An int that specifies the amount the left side of the graphic will be cropped.

getRightCropping

int getRightCropping()

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.

Returns:
An int that specifies the amount the right side of the graphic will be cropped.

getTopCropping

int getTopCropping()

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.

Returns:
An int that specifies the amount the top side of the graphic will be cropped.

getIsPreserveAspectRatio

boolean getIsPreserveAspectRatio()

Returns the value of "IsPreserveAspectRatio"

Returns:
A boolean that specifies if the picture will preserve aspect ratio

setBottomCropping

void setBottomCropping(int bottomCropping)

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.

Parameters:
bottomCropping - An int that specifies the amount the bottom side of the graphic will be cropped.

setLeftCropping

void setLeftCropping(int leftCropping)

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.

Parameters:
leftCropping - An int that specifies the amount the left side of the graphic will be cropped.

setRightCropping

void setRightCropping(int rightCropping)

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.

Parameters:
rightCropping - An int that specifies the amount the right side of the graphic will be cropped.

setTopCropping

void setTopCropping(int topCropping)

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.

Parameters:
topCropping - An int that specifies the amount the top side of the graphic will be cropped.

setIsPreserveAspectRatio

void setIsPreserveAspectRatio(boolean isPreserveAspectRatio)

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

Parameters:
isPreserveAspectRatio - An boolean that specifies the graphic will preserve aspect ratio or not.