com.groupdocs.watermark.contents

Class PresentationBaseShape

java.lang.Object

com.groupdocs.watermark.search.ShapeSearchAdapter

com.groupdocs.watermark.contents.PresentationBaseShape

All Implemented Interfaces:

IPresentationHyperlinkContainer, ITwoDObject

Direct Known Subclasses:

PresentationChart, PresentationShape

public abstract class PresentationBaseShape
extends ShapeSearchAdapter
implements ITwoDObject, IPresentationHyperlinkContainer

Provides the abstract base class for shapes of all types in a PowerPoint document.

Method Summary

Modifier and Type	Method and Description
String	getAlternativeText() Gets the descriptive (alternative) text associated with this PresentationBaseShape.
double	getHeight() Gets the height of this PresentationBaseShape in points.
String	getHyperlink(int actionType) Gets the hyperlink associated with this PresentationBaseShape.
long	getId() Gets the identifier of this PresentationBaseShape.
PresentationImageFillFormat	getImageFillFormat() Gets the image fill format settings of this PresentationBaseShape.
String	getName() Gets the name of this PresentationBaseShape.
PresentationBaseSlide	getPresentation() Gets the parent presentation of this PresentationBaseShape.
double	getWidth() Gets the width of this PresentationBaseShape in points.
double	getX() Gets the horizontal offset of this PresentationBaseShape from presentation left border in points.
double	getY() Gets or sets the vertical offset of this PresentationBaseShape from presentation top border in points.
int	getZOrderPosition() Gets the position of this PresentationBaseShape in the z-order.
void	setAlternativeText(String value) Sets the descriptive (alternative) text associated with this PresentationBaseShape.
void	setHeight(double value) Sets the height of this PresentationBaseShape in points.
void	setHyperlink(int actionType, String url) Sets the hyperlink associated with this PresentationBaseShape.
void	setWidth(double value) Sets the width of this PresentationBaseShape in points.
void	setX(double value) Sets the horizontal offset of this PresentationBaseShape from presentation left border in points.
void	setY(double value) Gets or sets the vertical offset of this PresentationBaseShape from presentation top border in points.

Methods inherited from class com.groupdocs.watermark.search.ShapeSearchAdapter

getFormattedTextFragmentsForSearch, getImageForSearch, getPageNumber, getTextForSearch, setFoundWatermarkImage, setFoundWatermarkText

Methods inherited from class java.lang.Object

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

Method Detail

getAlternativeText

public final String getAlternativeText()

Gets the descriptive (alternative) text associated with this PresentationBaseShape.

Returns:

The descriptive (alternative) text associated with this PresentationBaseShape.

getHeight

public final double getHeight()

Gets the height of this PresentationBaseShape in points.

Specified by:

getHeight in interface ITwoDObject

Returns:

The height of this PresentationBaseShape in points.

getHyperlink

public final String getHyperlink(int actionType)

Gets the hyperlink associated with this PresentationBaseShape.

Specified by:

getHyperlink in interface IPresentationHyperlinkContainer

Parameters:

actionType - The action that activates the hyperlink.

Returns:

The url of the hyperlink that is activated on specified action.

getId

public final long getId()

Gets the identifier of this PresentationBaseShape.

Returns:

The identifier of this PresentationBaseShape.

getImageFillFormat

public final PresentationImageFillFormat getImageFillFormat()

Gets the image fill format settings of this PresentationBaseShape.

Returns:

The image fill format settings of this PresentationBaseShape.

getName

public final String getName()

Gets the name of this PresentationBaseShape.

Returns:

The name of this PresentationBaseShape.

getPresentation

public final PresentationBaseSlide getPresentation()

Gets the parent presentation of this PresentationBaseShape.

Returns:

The parent presentation of this PresentationBaseShape.

getWidth

public final double getWidth()

Gets the width of this PresentationBaseShape in points.

Specified by:

getWidth in interface ITwoDObject

Returns:

The width of this PresentationBaseShape in points.

getX

public final double getX()

Gets the horizontal offset of this PresentationBaseShape from presentation left border in points.

Specified by:

getX in interface ITwoDObject

Returns:

The x-coordinate of this PresentationBaseShape.

getY

public final double getY()

Gets or sets the vertical offset of this PresentationBaseShape from presentation top border in points.

Specified by:

getY in interface ITwoDObject

Returns:

The y-coordinate of this PresentationBaseShape.

getZOrderPosition

public final int getZOrderPosition()

Gets the position of this PresentationBaseShape in the z-order.

A shape with greater z-order is always in front of a shape with a lower z-order.

Returns:

The position of this PresentationBaseShape in the z-order.

setAlternativeText

public final void setAlternativeText(String value)

Sets the descriptive (alternative) text associated with this PresentationBaseShape.

Parameters:

value - The descriptive (alternative) text associated with this PresentationBaseShape.

setHeight

public final void setHeight(double value)

Sets the height of this PresentationBaseShape in points.

Parameters:

value - The height of this PresentationBaseShape in points.

setHyperlink

public final void setHyperlink(int actionType,
                               String url)

Sets the hyperlink associated with this PresentationBaseShape.

Specified by:

setHyperlink in interface IPresentationHyperlinkContainer

Parameters:

actionType - The action that activates the hyperlink.

url - The hyperlink url.

setWidth

public final void setWidth(double value)

Sets the width of this PresentationBaseShape in points.

Parameters:

value - The width of this PresentationBaseShape in points.

setX

public final void setX(double value)

Sets the horizontal offset of this PresentationBaseShape from presentation left border in points.

Parameters:

value - The x-coordinate of this PresentationBaseShape.

setY

public final void setY(double value)

Gets or sets the vertical offset of this PresentationBaseShape from presentation top border in points.

Parameters:

value - The y-coordinate of this PresentationBaseShape.