com.aspose.slides

Interfaces

Classes

Exceptions

com.aspose.slides

Class Shape

  • java.lang.Object
    • com.aspose.slides.Shape
    • Method Detail

      • isTextHolder

        public final boolean isTextHolder()

        Determines whether the shape is TextHolder_PPT. Read-only boolean.

        Specified by:
        isTextHolder in interface IShape
      • removePlaceholder

        public final void removePlaceholder()

        Defines that this shape isn't a placeholder.

        Specified by:
        removePlaceholder in interface IShape
      • addPlaceholder

        public final IPlaceholder addPlaceholder(IPlaceholder placeholderToCopyFrom)

        Adds a new placeholder if there is no and sets placeholder properties to a specified one.

        Specified by:
        addPlaceholder in interface IShape
        Parameters:
        placeholderToCopyFrom - Placeholder to copy content from.
        Returns:
        New Placeholder(getPlaceholder()).
      • getRawFrame

        public final IShapeFrame getRawFrame()

        Returns or sets the raw shape frame's properties. Read/write IShapeFrame.


        Code that attempts to assign undefined frame to IShape.getFrame() doesn't make sense in general case (particularly in case when parent GroupShape is multiple nested into other GroupShape-s). For example: {code}IShape shape = ...; shape.setFrame(new ShapeFrame(Float.NaN, Float.NaN, Float.NaN, Float.NaN, NullableBool.NotDefined, NullableBool.NotDefined, Float.NaN));{code} or {code}slide.getShapes().addAutoShape(ShapeType.RoundCornerRectangle, Float.NaN, Float.NaN, Float.NaN, Float.NaN);{code} Such code can lead to unclear situations. So restrictions had been added for using undefined values for IShape.getFrame(). Values of x, y, width, height, flipH, flipV and rotationAngle must be defined (not Float.NaN or NullableBool.NotDefined). Example code above now throws ArgumentException exception. This applies to these use cases: {code}IShape shape = ...; shape.setFrame(...); // cannot be undefined IShapeCollection shapes = ...; // x, y, width, height parameters cannot be Float.NaN: { shapes.addAudioFrameCD(...); shapes.addAudioFrameEmbedded(...); shapes.addAudioFrameLinked(...); shapes.addAutoShape(...); shapes.addChart(...); shapes.addConnector(...); shapes.addOleObjectFrame(...); shapes.addPictureFrame(...); shapes.addSmartArt(...); shapes.addTable(...); shapes.addVideoFrame(...); shapes.insertAudioFrameEmbedded(...); shapes.insertAudioFrameLinked(...); shapes.insertAutoShape(...); shapes.insertChart(...); shapes.insertConnector(...); shapes.insertOleObjectFrame(...); shapes.insertPictureFrame(...); shapes.insertTable(...); shapes.insertVideoFrame(...); }{code} But IShape.getRawFrame() frame properties can be undefined. This make sense when shape is linked to placeholder. Then undefined shape frame values is overridden from the parent placeholder shape. If there is no parent placeholder shape for that shape then that shape uses default values when it evaluates effective frame based on its IShape.getRawFrame(). Default values are 0 and NullableBool.False for x, y, width, height, flipH, flipV and rotationAngle. For example: {code}IShape shape = ...; // shape is linked to placeholder shape.setRawFrame(new ShapeFrame(Float.NaN, Float.NaN, 100, Float.NaN, NullableBool.NotDefined, NullableBool.NotDefined, 0)); // now shape inherits x, y, height, flipH, flipV values form placeholder and overrides width=100 and rotationAngle=0.{code}

        Specified by:
        getRawFrame in interface IShape
      • setRawFrame

        public final void setRawFrame(IShapeFrame value)

        Returns or sets the raw shape frame's properties. Read/write IShapeFrame.


        Code that attempts to assign undefined frame to IShape.getFrame() doesn't make sense in general case (particularly in case when parent GroupShape is multiple nested into other GroupShape-s). For example: {code}IShape shape = ...; shape.setFrame(new ShapeFrame(Float.NaN, Float.NaN, Float.NaN, Float.NaN, NullableBool.NotDefined, NullableBool.NotDefined, Float.NaN));{code} or {code}slide.getShapes().addAutoShape(ShapeType.RoundCornerRectangle, Float.NaN, Float.NaN, Float.NaN, Float.NaN);{code} Such code can lead to unclear situations. So restrictions had been added for using undefined values for IShape.getFrame(). Values of x, y, width, height, flipH, flipV and rotationAngle must be defined (not Float.NaN or NullableBool.NotDefined). Example code above now throws ArgumentException exception. This applies to these use cases: {code}IShape shape = ...; shape.setFrame(...); // cannot be undefined IShapeCollection shapes = ...; // x, y, width, height parameters cannot be Float.NaN: { shapes.addAudioFrameCD(...); shapes.addAudioFrameEmbedded(...); shapes.addAudioFrameLinked(...); shapes.addAutoShape(...); shapes.addChart(...); shapes.addConnector(...); shapes.addOleObjectFrame(...); shapes.addPictureFrame(...); shapes.addSmartArt(...); shapes.addTable(...); shapes.addVideoFrame(...); shapes.insertAudioFrameEmbedded(...); shapes.insertAudioFrameLinked(...); shapes.insertAutoShape(...); shapes.insertChart(...); shapes.insertConnector(...); shapes.insertOleObjectFrame(...); shapes.insertPictureFrame(...); shapes.insertTable(...); shapes.insertVideoFrame(...); }{code} But IShape.getRawFrame() frame properties can be undefined. This make sense when shape is linked to placeholder. Then undefined shape frame values is overridden from the parent placeholder shape. If there is no parent placeholder shape for that shape then that shape uses default values when it evaluates effective frame based on its IShape.getRawFrame(). Default values are 0 and NullableBool.False for x, y, width, height, flipH, flipV and rotationAngle. For example: {code}IShape shape = ...; // shape is linked to placeholder shape.setRawFrame(new ShapeFrame(Float.NaN, Float.NaN, 100, Float.NaN, NullableBool.NotDefined, NullableBool.NotDefined, 0)); // now shape inherits x, y, height, flipH, flipV values form placeholder and overrides width=100 and rotationAngle=0.{code}

        Specified by:
        setRawFrame in interface IShape
      • getFrame

        public final IShapeFrame getFrame()

        Returns or sets the shape frame's properties. Read/write IShapeFrame.


        Value of each property of the returned IShapeFrame instance is not undefined (is not NaN or NotDefined). Value of each property of the assigned IShapeFrame instance must be not undefined (must be not NaN or NotDefined). You can set undefined values for RawFrame instance properties.

        Specified by:
        getFrame in interface IShape
      • setFrame

        public final void setFrame(IShapeFrame value)

        Returns or sets the shape frame's properties. Read/write IShapeFrame.


        Value of each property of the returned IShapeFrame instance is not undefined (is not NaN or NotDefined). Value of each property of the assigned IShapeFrame instance must be not undefined (must be not NaN or NotDefined). You can set undefined values for RawFrame instance properties.

        Specified by:
        setFrame in interface IShape
      • getLineFormat

        public ILineFormat getLineFormat()

        Returns the LineFormat object that contains line formatting properties for a shape. Note: can return null for certain types of shapes which don't have line properties. Read-only ILineFormat.

        Specified by:
        getLineFormat in interface IShape
      • getThreeDFormat

        public IThreeDFormat getThreeDFormat()

        Returns the ThreeDFormat object that 3d effect properties for a shape. Note: can return null for certain types of shapes which don't have 3d properties. Read-only IThreeDFormat.

        Specified by:
        getThreeDFormat in interface IShape
      • getEffectFormat

        public IEffectFormat getEffectFormat()

        Returns the EffectFormat object which contains pixel effects applied to a shape. Note: can return null for certain types of shapes which don't have effect properties. Read-only IEffectFormat.

        Specified by:
        getEffectFormat in interface IShape
      • getFillFormat

        public IFillFormat getFillFormat()

        Returns the FillFormat object that contains fill formatting properties for a shape. Note: can return null for certain types of shapes which don't have fill properties. Read-only IFillFormat.

        Specified by:
        getFillFormat in interface IShape
      • getThumbnail

        public final java.awt.image.BufferedImage getThumbnail()

        Returns shape thumbnail. ShapeThumbnailBounds.Shape shape thumbnail bounds type is used by default.

        Specified by:
        getThumbnail in interface IShape
        Returns:
        Shape thumbnail.
      • getThumbnail

        public final java.awt.image.BufferedImage getThumbnail(int bounds,
                                                               float scaleX,
                                                               float scaleY)

        Returns shape thumbnail.

        Specified by:
        getThumbnail in interface IShape
        Parameters:
        bounds - Shape thumbnail bounds type.
        scaleX - X scale
        scaleY - Y scale
        Returns:
        Shape thumbnail or null in case when ShapeThumbnailBounds.Appearance is used and a shape doesn't have visible elements.
      • writeAsSvg

        public final void writeAsSvg(java.io.OutputStream stream)

        Saves content of Shape as SVG file.

        Specified by:
        writeAsSvg in interface IShape
        Parameters:
        stream - Target stream
      • writeAsSvg

        public final void writeAsSvg(java.io.OutputStream stream,
                                     ISVGOptions svgOptions)

        Saves content of Shape as SVG file.

        Specified by:
        writeAsSvg in interface IShape
        Parameters:
        stream - Target stream
        svgOptions - SVG generation options
      • getHidden

        public final boolean getHidden()

        Determines whether the shape is hidden. Read/write boolean.

        Specified by:
        getHidden in interface IShape
      • setHidden

        public final void setHidden(boolean value)

        Determines whether the shape is hidden. Read/write boolean.

        Specified by:
        setHidden in interface IShape
      • getZOrderPosition

        public int getZOrderPosition()

        Returns the position of a shape in the z-order. Shapes[0] returns the shape at the back of the z-order, and Shapes[Shapes.Count - 1] returns the shape at the front of the z-order. Read-only int.

        Specified by:
        getZOrderPosition in interface IShape
      • getConnectionSiteCount

        public final int getConnectionSiteCount()

        Returns the number of connection sites on the shape. Read-only int.

        Specified by:
        getConnectionSiteCount in interface IShape
      • getRotation

        public final float getRotation()

        Returns or sets the number of degrees the specified shape is rotated around the z-axis. A positive value indicates clockwise rotation; a negative value indicates counterclockwise rotation. Read/write float.


        Returned value is always defined (is not Float.NaN). Assigned value must be defined (not Float.NaN). You can set undefined values for RawFrame instance properties.

        Specified by:
        getRotation in interface IShape
      • setRotation

        public final void setRotation(float value)

        Returns or sets the number of degrees the specified shape is rotated around the z-axis. A positive value indicates clockwise rotation; a negative value indicates counterclockwise rotation. Read/write float.


        Returned value is always defined (is not Float.NaN). Assigned value must be defined (not Float.NaN). You can set undefined values for RawFrame instance properties.

        Specified by:
        setRotation in interface IShape
      • getX

        public final float getX()

        Returns or sets the x-coordinate of the upper-left corner of the shape. Read/write float.


        Returned value is always defined (is not Float.NaN). Assigned value must be defined (not Float.NaN). You can set undefined values for RawFrame instance properties.

        Specified by:
        getX in interface IShape
      • setX

        public final void setX(float value)

        Returns or sets the x-coordinate of the upper-left corner of the shape. Read/write float.


        Returned value is always defined (is not Float.NaN). Assigned value must be defined (not Float.NaN). You can set undefined values for RawFrame instance properties.

        Specified by:
        setX in interface IShape
      • getY

        public final float getY()

        Returns or sets the y-coordinate of the upper-left corner of the shape. Read/write float.


        Returned value is always defined (is not Float.NaN). Assigned value must be defined (not Float.NaN). You can set undefined values for RawFrame instance properties.

        Specified by:
        getY in interface IShape
      • setY

        public final void setY(float value)

        Returns or sets the y-coordinate of the upper-left corner of the shape. Read/write float.


        Returned value is always defined (is not Float.NaN). Assigned value must be defined (not Float.NaN). You can set undefined values for RawFrame instance properties.

        Specified by:
        setY in interface IShape
      • getWidth

        public final float getWidth()

        Returns or sets the width of the shape. Read/write float.


        Returned value is always defined (is not Float.NaN). Assigned value must be defined (not Float.NaN). You can set undefined values for RawFrame instance properties.

        Specified by:
        getWidth in interface IShape
      • setWidth

        public final void setWidth(float value)

        Returns or sets the width of the shape. Read/write float.


        Returned value is always defined (is not Float.NaN). Assigned value must be defined (not Float.NaN). You can set undefined values for RawFrame instance properties.

        Specified by:
        setWidth in interface IShape
      • getHeight

        public final float getHeight()

        Returns or sets the height of the shape. Read/write float.


        Returned value is always defined (is not Float.NaN). Assigned value must be defined (not Float.NaN). You can set undefined values for RawFrame instance properties.

        Specified by:
        getHeight in interface IShape
      • setHeight

        public final void setHeight(float value)

        Returns or sets the height of the shape. Read/write float.


        Returned value is always defined (is not Float.NaN). Assigned value must be defined (not Float.NaN). You can set undefined values for RawFrame instance properties.

        Specified by:
        setHeight in interface IShape
      • getBlackWhiteMode

        public final byte getBlackWhiteMode()

        Property specifies how a shape will render in black-and-white display mode.. Read/write BlackWhiteMode.

        Specified by:
        getBlackWhiteMode in interface IShape
      • setBlackWhiteMode

        public final void setBlackWhiteMode(byte value)

        Property specifies how a shape will render in black-and-white display mode.. Read/write BlackWhiteMode.

        Specified by:
        setBlackWhiteMode in interface IShape
      • getUniqueId

        public final long getUniqueId()

        Gets unique shape identifier in presentation scope. Read-only long. See also OfficeInteropShapeId(getOfficeInteropShapeId()) for getting unique shape identifier in slide scope.

        Specified by:
        getUniqueId in interface IShape
      • getOfficeInteropShapeId

        public final long getOfficeInteropShapeId()

        Gets unique shape identifier in slide scope. Read-only long. See also UniqueId(getUniqueId()) for getting unique shape identifier in presentation scope.

        Specified by:
        getOfficeInteropShapeId in interface IShape
      • getAlternativeText

        public java.lang.String getAlternativeText()

        Returns or sets the alternative text associated with a shape. Read/write String.

        Specified by:
        getAlternativeText in interface IShape
      • setAlternativeText

        public void setAlternativeText(java.lang.String value)

        Returns or sets the alternative text associated with a shape. Read/write String.

        Specified by:
        setAlternativeText in interface IShape
      • getName

        public java.lang.String getName()

        Returns or sets the name of a shape. Must be not null. Use empty string value if needed. Read/write String.

        Specified by:
        getName in interface IShape
      • setName

        public void setName(java.lang.String value)

        Returns or sets the name of a shape. Must be not null. Use empty string value if needed. Read/write String.

        Specified by:
        setName in interface IShape
      • isGrouped

        public final boolean isGrouped()

        Determines whether the shape is grouped. Read-only boolean.


        Property ParentGroup(getParentGroup()) returns parent GroupShape object if shape is grouped.

        Specified by:
        isGrouped in interface IShape
      • getParentGroup

        public final IGroupShape getParentGroup()

        Returns parent GroupShape object if shape is grouped. Otherwise returns null. Read-only IGroupShape.


        Property IsGrouped(isGrouped()) determines whether the shape is grouped.

        Specified by:
        getParentGroup in interface IShape
      • getParent_Immediate

        public final com.aspose.slides.IDOMObject getParent_Immediate()

        Returns Parent_Immediate object. Read-only IDOMObject.