com.aspose.slides
Class PictureFrame

java.lang.Object
  extended by com.aspose.slides.Shape
      extended by com.aspose.slides.PictureFrame
All Implemented Interfaces:
IPictureFrame, IShape, IShapeFormat
Direct Known Subclasses:
AudioFrame, OleObjectFrame, VideoFrame

public class PictureFrame
extends Shape
implements IPictureFrame

Represents the PictureFrame shape.


Method Summary
 void addTextFrame(java.lang.String text)
          Adds a new TextFrame to a shape.
 int getBrightness()
          Returns the brightness (0-100%) of a picture.
 int getColorType()
          Returns the type of color transformation applied to a picture.
 int getContrast()
          Returns the contrast (0-100%) of a picture.
 float getCropBottom()
          Returns the number of percents of real image height that are cropped off the bottom of the picture.
 float getCropLeft()
          Returns the number of percents of real image width that are cropped off the left of the picture.
 float getCropRight()
          Returns the number of percents of real image width that are cropped off the right of the picture.
 float getCropTop()
          Returns the number of percents of real image height that are cropped off the top of the picture.
 java.lang.String getPictureFileName()
          Returns the file name of a linked picture.
 int getPictureId()
          Returns the picture Id for a PictureFrame.
 RecolorTable getRecolor()
          Returns the table of colors replacements for recoloring metafiles.
 java.awt.Color getTransparentColor()
          Returns the transparent color of a picture.
 boolean isPictureLinked()
          Determines whether the picture is linked to external file.
 void serialize(java.io.OutputStream stream)
          Serializes a PictureFrame object to the stream.
 void setBrightness(int value)
          Sets the brightness (0-100%) of a picture.
 void setColorType(int value)
          Sets the type of color transformation applied to a picture.
 void setContrast(int value)
          Sets the contrast (0-100%) of a picture.
 void setCropBottom(float value)
          Sets the number of percents of real image height that are cropped off the bottom of the picture.
 void setCropLeft(float value)
          Sets the number of percents of real image width that are cropped off the left of the picture.
 void setCropRight(float value)
          Sets the number of percents of real image width that are cropped off the right of the picture.
 void setCropTop(float value)
          Sets the number of percents of real image height that are cropped off the top of the picture.
 void setPictureFileName(java.lang.String value)
          Sets the file name of a linked picture.
 void setPictureId(int value)
          Sets the picture Id for a PictureFrame.
 void setTransparentColor(java.awt.Color value)
          sets the transparent color of a picture.
 
Methods inherited from class com.aspose.slides.Shape
addLink, clearLink, createShapeElements, createShapeElements, getAlternativeText, getAnimationSettings, getConnectionSites, getConnectionSitesRaw, getFillFormat, getHeight, getLineFormat, getLink, getName, getParent, getPlaceholder, getRotation, getShadowFormat, getShapeRectangle, getTags, getTextFrame, getThreeDFormat, getWidth, getX, getY, getZOrderPosition, isFlipH, isFlipV, isHidden, isMasterTextHolder, isTextHolder, setAlternativeText, setFlipH, setFlipV, setHeight, setHidden, setName, setRotation, setWidth, setX, setY, zOrder
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

serialize

public void serialize(java.io.OutputStream stream)
               throws PptException
Serializes a PictureFrame object to the stream.

Overrides:
serialize in class Shape
Parameters:
stream - The stream to which the PictureFrame is to be serialized.
Throws:
PptException

getCropTop

public float getCropTop()
Returns the number of percents of real image height that are cropped off the top of the picture.

Specified by:
getCropTop in interface IPictureFrame
Returns:
The percents of image height cropped from top.

setCropTop

public void setCropTop(float value)
Sets the number of percents of real image height that are cropped off the top of the picture.

Specified by:
setCropTop in interface IPictureFrame
Parameters:
value - the percents of image height cropped from top.

getCropBottom

public float getCropBottom()
Returns the number of percents of real image height that are cropped off the bottom of the picture.

Specified by:
getCropBottom in interface IPictureFrame
Returns:
The percents of image height cropped from bottom.

setCropBottom

public void setCropBottom(float value)
Sets the number of percents of real image height that are cropped off the bottom of the picture.

Specified by:
setCropBottom in interface IPictureFrame
Parameters:
value - the percents of image height cropped from bottom.

getCropLeft

public float getCropLeft()
Returns the number of percents of real image width that are cropped off the left of the picture.

Specified by:
getCropLeft in interface IPictureFrame
Returns:
The percents of image width cropped from left.

setCropLeft

public void setCropLeft(float value)
Sets the number of percents of real image width that are cropped off the left of the picture.

Specified by:
setCropLeft in interface IPictureFrame
Parameters:
value - the percents of image width cropped from left.

getCropRight

public float getCropRight()
Returns the number of percents of real image width that are cropped off the right of the picture.

Specified by:
getCropRight in interface IPictureFrame
Returns:
The percents of image width cropped from right.

setCropRight

public void setCropRight(float value)
Sets the number of percents of real image width that are cropped off the right of the picture.

Specified by:
setCropRight in interface IPictureFrame
Parameters:
value - the percents of image width cropped from right.

getTransparentColor

public java.awt.Color getTransparentColor()
Returns the transparent color of a picture.

Specified by:
getTransparentColor in interface IPictureFrame
Returns:
the transparent color of a picture. See Color.

setTransparentColor

public void setTransparentColor(java.awt.Color value)
sets the transparent color of a picture.

Specified by:
setTransparentColor in interface IPictureFrame
Parameters:
value - the transparent color of a picture. See Color.

getBrightness

public int getBrightness()
Returns the brightness (0-100%) of a picture.

Specified by:
getBrightness in interface IPictureFrame
Returns:
the brightness (0-100%) of a picture.

setBrightness

public void setBrightness(int value)
                   throws PptPropertyException
Sets the brightness (0-100%) of a picture.

Specified by:
setBrightness in interface IPictureFrame
Parameters:
value - the brightness (0-100%) of a picture.
Throws:
PptPropertyException

getContrast

public int getContrast()
Returns the contrast (0-100%) of a picture.

Specified by:
getContrast in interface IPictureFrame
Returns:
the contrast (0-100%) of a picture.

setContrast

public void setContrast(int value)
                 throws PptPropertyException
Sets the contrast (0-100%) of a picture.

Specified by:
setContrast in interface IPictureFrame
Parameters:
value - the contrast (0-100%) of a picture.
Throws:
PptPropertyException

getColorType

public int getColorType()
Returns the type of color transformation applied to a picture.

Specified by:
getColorType in interface IPictureFrame
Returns:
the type of color transformation applied to a picture. See PictureColorType.

setColorType

public void setColorType(int value)
Sets the type of color transformation applied to a picture.

Specified by:
setColorType in interface IPictureFrame
Parameters:
value - the type of color transformation applied to a picture. See PictureColorType.

getRecolor

public RecolorTable getRecolor()
Returns the table of colors replacements for recoloring metafiles.

Specified by:
getRecolor in interface IPictureFrame
Returns:
the table of colors replacements for recoloring metafiles. See RecolorTable.

getPictureId

public int getPictureId()
Returns the picture Id for a PictureFrame.

Specified by:
getPictureId in interface IPictureFrame
Returns:
The picture Id.

setPictureId

public void setPictureId(int value)
Sets the picture Id for a PictureFrame.

Specified by:
setPictureId in interface IPictureFrame
Parameters:
value - the picture Id.

isPictureLinked

public boolean isPictureLinked()
Determines whether the picture is linked to external file.

Specified by:
isPictureLinked in interface IPictureFrame
Returns:
true if picture is linked to external file.

getPictureFileName

public java.lang.String getPictureFileName()
Returns the file name of a linked picture.

Specified by:
getPictureFileName in interface IPictureFrame
Returns:
the file name of a linked picture.

setPictureFileName

public void setPictureFileName(java.lang.String value)
Sets the file name of a linked picture.

Specified by:
setPictureFileName in interface IPictureFrame
Parameters:
value - the file name of a linked picture.

addTextFrame

public void addTextFrame(java.lang.String text)
                  throws PptEditException
Adds a new TextFrame to a shape. If shape already has TextFrame then do nothing.

Overrides:
addTextFrame in class Shape
Parameters:
text - Default text for a new TextFrame.
Throws:
PptEditException