com.aspose.slides

Class ZoomObject

java.lang.Object

com.aspose.slides.Shape

com.aspose.slides.GraphicalObject

com.aspose.slides.ZoomObject

All Implemented Interfaces:

IGraphicalObject, IHyperlinkContainer, IPresentationComponent, IShape, ISlideComponent, IZoomObject

Direct Known Subclasses:

SectionZoomFrame, ZoomFrame

public class ZoomObject
extends GraphicalObject
implements IZoomObject

Represents an Zoom object in a slide.

Method Summary

Modifier and Type	Method and Description
int	getImageType() Gets or sets the image type of a zoom object.
boolean	getReturnToParent() Gets or sets the navigation behavior in slideshow.
boolean	getShowBackground() Gets or sets value that specifies whether the Zoom will use the background of the destination slide.
float	getTransitionDuration() Gets or sets the duration of the transition between Zoom and slide.
IPPImage	getZoomImage() Gets or sets image for zoom object.
void	setImageType(int value) Gets or sets the image type of a zoom object.
void	setReturnToParent(boolean value) Gets or sets the navigation behavior in slideshow.
void	setShowBackground(boolean value) Gets or sets value that specifies whether the Zoom will use the background of the destination slide.
void	setTransitionDuration(float value) Gets or sets the duration of the transition between Zoom and slide.
void	setZoomImage(IPPImage value) Gets or sets image for zoom object.

Methods inherited from class com.aspose.slides.GraphicalObject

getGraphicalObjectLock

Methods inherited from class com.aspose.slides.Shape

addPlaceholder, getAlternativeText, getAlternativeTextTitle, getBasePlaceholder, getBlackWhiteMode, getConnectionSiteCount, getCustomData, getEffectFormat, getFillFormat, getFrame, getHeight, getHidden, getHyperlinkClick, getHyperlinkManager, getHyperlinkMouseOver, getImage, getImage, getLineFormat, getName, getOfficeInteropShapeId, getParent_Immediate, getParentGroup, getPlaceholder, getPresentation, getRawFrame, getRotation, getShapeLock, getSlide, getThreeDFormat, getThumbnail, getThumbnail, getUniqueId, getWidth, getX, getY, getZOrderPosition, isDecorative, isGrouped, isTextHolder, removePlaceholder, setAlternativeText, setAlternativeTextTitle, setBlackWhiteMode, setDecorative, setFrame, setHeight, setHidden, setHyperlinkClick, setHyperlinkMouseOver, setName, setRawFrame, setRotation, setWidth, setX, setY, writeAsSvg, writeAsSvg

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.aspose.slides.IGraphicalObject

getGraphicalObjectLock

Methods inherited from interface com.aspose.slides.IShape

addPlaceholder, getAlternativeText, getAlternativeTextTitle, getBasePlaceholder, getBlackWhiteMode, getConnectionSiteCount, getCustomData, getEffectFormat, getFillFormat, getFrame, getHeight, getHidden, getImage, getImage, getLineFormat, getName, getOfficeInteropShapeId, getParentGroup, getPlaceholder, getRawFrame, getRotation, getShapeLock, getThreeDFormat, getThumbnail, getThumbnail, getUniqueId, getWidth, getX, getY, getZOrderPosition, isDecorative, isGrouped, isTextHolder, removePlaceholder, setAlternativeText, setAlternativeTextTitle, setBlackWhiteMode, setDecorative, setFrame, setHeight, setHidden, setName, setRawFrame, setRotation, setWidth, setX, setY, writeAsSvg, writeAsSvg

Methods inherited from interface com.aspose.slides.ISlideComponent

getSlide

Methods inherited from interface com.aspose.slides.IPresentationComponent

getPresentation

Methods inherited from interface com.aspose.slides.IHyperlinkContainer

getHyperlinkClick, getHyperlinkManager, getHyperlinkMouseOver, setHyperlinkClick, setHyperlinkMouseOver

Method Detail

getImageType

public final int getImageType()

Gets or sets the image type of a zoom object. Read/write ZoomImageType. Default value: Preview

Next example demonstrates changing Image Type to Preview value. 
 In this case current image of a Zoom object changes to slide image:
 
 Presentation pres = new Presentation("pres.pptx");
 try {
     IPPImage image = pres.getImages().addImage(Files.readAllBytes(Paths.get("image.png")));
     IZoomFrame zoomFrame = pres.getSlides().get_Item(0).getShapes().addZoomFrame(150, 20, 50, 50, pres.getSlides().get_Item(1), image);
     zoomFrame.setImageType(ZoomImageType.Preview);
 } catch(IOException e) {
 } finally {
     if (pres != null) pres.dispose();
 }
 
 

Specifies whether the Zoom object is using the slide preview or a cover image.

Specified by:

getImageType in interface IZoomObject

setImageType

public final void setImageType(int value)

Gets or sets the image type of a zoom object. Read/write ZoomImageType. Default value: Preview

Next example demonstrates changing Image Type to Preview value. 
 In this case current image of a Zoom object changes to slide image:
 
 Presentation pres = new Presentation("pres.pptx");
 try {
     IPPImage image = pres.getImages().addImage(Files.readAllBytes(Paths.get("image.png")));
     IZoomFrame zoomFrame = pres.getSlides().get_Item(0).getShapes().addZoomFrame(150, 20, 50, 50, pres.getSlides().get_Item(1), image);
     zoomFrame.setImageType(ZoomImageType.Preview);
 } catch(IOException e) {
 } finally {
     if (pres != null) pres.dispose();
 }
 
 

Specifies whether the Zoom object is using the slide preview or a cover image.

Specified by:

setImageType in interface IZoomObject

getReturnToParent

public final boolean getReturnToParent()

Gets or sets the navigation behavior in slideshow. Read/write boolean. Default value: false

Example:
 
 Presentation pres = new Presentation("pres.pptx");
 try {
      IZoomFrame zoomFrame = pres.getSlides().get_Item(0).getShapes().addZoomFrame(150, 20, 50, 50, pres.getSlides().get_Item(1));
      zoomFrame.setReturnToParent(true);
 } finally {
     if (pres != null) pres.dispose();
 }
 
 

True value of the property specifies return to parent navigation behavior in slideshow.

Specified by:

getReturnToParent in interface IZoomObject

setReturnToParent

public final void setReturnToParent(boolean value)

Gets or sets the navigation behavior in slideshow. Read/write boolean. Default value: false

Example:
 
 Presentation pres = new Presentation("pres.pptx");
 try {
      IZoomFrame zoomFrame = pres.getSlides().get_Item(0).getShapes().addZoomFrame(150, 20, 50, 50, pres.getSlides().get_Item(1));
      zoomFrame.setReturnToParent(true);
 } finally {
     if (pres != null) pres.dispose();
 }
 
 

True value of the property specifies return to parent navigation behavior in slideshow.

Specified by:

setReturnToParent in interface IZoomObject

getShowBackground

public final boolean getShowBackground()

Gets or sets value that specifies whether the Zoom will use the background of the destination slide. Read/write boolean. Default value: true

the example demonstrates removing the background of an image of a Zoom object:
 
 Presentation pres = new Presentation("pres.pptx");
 try {
      IZoomFrame zoomFrame = pres.getSlides().get_Item(0).getShapes().addZoomFrame(150, 20, 50, 50, pres.getSlides().get_Item(1));
      zoomFrame.setShowBackground(false);
 } finally {
     if (pres != null) pres.dispose();
 }
 
 

Specified by:

getShowBackground in interface IZoomObject

setShowBackground

public final void setShowBackground(boolean value)

Gets or sets value that specifies whether the Zoom will use the background of the destination slide. Read/write boolean. Default value: true

the example demonstrates removing the background of an image of a Zoom object:
 
 Presentation pres = new Presentation("pres.pptx");
 try {
      IZoomFrame zoomFrame = pres.getSlides().get_Item(0).getShapes().addZoomFrame(150, 20, 50, 50, pres.getSlides().get_Item(1));
      zoomFrame.setShowBackground(false);
 } finally {
     if (pres != null) pres.dispose();
 }
 
 

Specified by:

setShowBackground in interface IZoomObject

getZoomImage

public final IPPImage getZoomImage()

Gets or sets image for zoom object. Read/write IPPImage.

the example demonstrates changing an image of a Zoom object:
 
 Presentation pres = new Presentation("pres.pptx");
 try {
     IZoomFrame zoomFrame = pres.getSlides().get_Item(0).getShapes().addZoomFrame(150, 20, 50, 50, pres.getSlides().get_Item(1));
     IPPImage image = pres.getImages().addImage(Files.readAllBytes(Paths.get("image.png")));
     zoomFrame.setImage(image);
 } catch(IOException e) {
 } finally {
     if (pres != null) pres.dispose();
 }
 
 

Specified by:

getZoomImage in interface IZoomObject

setZoomImage

public final void setZoomImage(IPPImage value)

Gets or sets image for zoom object. Read/write IPPImage.

the example demonstrates changing an image of a Zoom object:
 
 Presentation pres = new Presentation("pres.pptx");
 try {
     IZoomFrame zoomFrame = pres.getSlides().get_Item(0).getShapes().addZoomFrame(150, 20, 50, 50, pres.getSlides().get_Item(1));
     IPPImage image = pres.getImages().addImage(Files.readAllBytes(Paths.get("image.png")));
     zoomFrame.setImage(image);
 } catch(IOException e) {
 } finally {
     if (pres != null) pres.dispose();
 }
 
 

Specified by:

setZoomImage in interface IZoomObject

getTransitionDuration

public final float getTransitionDuration()

Gets or sets the duration of the transition between Zoom and slide. Read/write float. Default value: 1.0f

the example demonstrates changing the duration of the transition between Zoom and slide:
 
 Presentation pres = new Presentation("pres.pptx");
 try {
      IZoomFrame zoomFrame = pres.getSlides().get_Item(0).getShapes().addZoomFrame(150, 20, 50, 50, pres.getSlides().get_Item(1));
      zoomFrame.setTransitionDuration(2.5f);
 } finally {
     if (pres != null) pres.dispose();
 }
 
 

If not specified (TransitionDur = 0), it will use the destination slide transition and the timings associated with that transition.

Specified by:

getTransitionDuration in interface IZoomObject

setTransitionDuration

public final void setTransitionDuration(float value)

Gets or sets the duration of the transition between Zoom and slide. Read/write float. Default value: 1.0f

the example demonstrates changing the duration of the transition between Zoom and slide:
 
 Presentation pres = new Presentation("pres.pptx");
 try {
      IZoomFrame zoomFrame = pres.getSlides().get_Item(0).getShapes().addZoomFrame(150, 20, 50, 50, pres.getSlides().get_Item(1));
      zoomFrame.setTransitionDuration(2.5f);
 } finally {
     if (pres != null) pres.dispose();
 }
 
 

If not specified (TransitionDur = 0), it will use the destination slide transition and the timings associated with that transition.

Specified by:

setTransitionDuration in interface IZoomObject