com.spire.doc.fields
Class ShapeObject

java.lang.Object
  com.spire.doc.OwnerHolder
      com.spire.doc.documents.xml.DocumentSerializable
          com.spire.doc.DocumentObject
              com.spire.doc.DocumentBase
                  com.spire.doc.fields.ParagraphBase
                      com.spire.doc.fields.shape.ShapeBase
                          com.spire.doc.fields.ShapeObject

All Implemented Interfaces:

IRunAttrSource, ICompositeObject, IDocumentObject, IParagraphBase

Direct Known Subclasses:

DocOleObject, DocPicture, ShapeGroup, TextBox

public class ShapeObject
extends ShapeBase

Constructor Summary

ShapeObject(IDocument doc)
Ctor.

ShapeObject(IDocument doc, ShapeType shapeType)
Creates a new shape object.

Method Summary

CharacterFormat	getCharacterFormat() Gets shape object's character format.
DocumentObjectCollection	getChildObjects() Gets the child objects of the entity.
DocumentObjectType	getDocumentObjectType() Gets the type of the document object.
java.awt.Color	getFillColor() Gets the brush color that fills the closed path of the shape.
ShapeLineStyle	getLineStyle() Gets the line style of the stroke.
java.awt.Color	getStrokeColor() Gets the color of a stroke.
double	getStrokeWeight() Defines the brush thickness that strokes the path of a shape in points.
WordArt	getWordArt() Defines the text of the text path (of a WordArt object).
boolean	hasImage() Returns true if the shape has image bytes or links an image.
void	setFillColor(java.awt.Color value) Sets the brush color that fills the closed path of the shape.
void	setLineStyle(ShapeLineStyle value) Sets the line style of the stroke.
void	setStrokeColor(java.awt.Color value) Sets the color of a stroke.
void	setStrokeWeight(double value) Defines the brush thickness that strokes the path of a shape in points.

Methods inherited from class com.spire.doc.fields.shape.ShapeBase

getAllowOverlap, getBehindText, getBottom, getDistanceBottom, getDistanceLeft, getDistanceRight, getDistanceTop, getHeight, getHorizontalAlignment, getHorizontalOrigin, getHorizontalPosition, getParentParagraph, getRight, getRotation, getShapeType, getTextWrappingStyle, getTextWrappingType, getVerticalAlignment, getVerticalOrigin, getVerticalPosition, getWidth, getZOrder, hasKey, isImage, localToParent, removeShapeAttribute, setAllowOverlap, setBehindText, setDistanceBottom, setDistanceLeft, setDistanceRight, setDistanceTop, setHeight, setHorizontalAlignment, setHorizontalOrigin, setHorizontalPosition, setRotation, setShapeAttr, setShapeAttribute, setShapeType, setTextWrappingStyle, setTextWrappingType, setVerticalAlignment, setVerticalOrigin, setVerticalPosition, setWidth, setZOrder

Methods inherited from class com.spire.doc.fields.ParagraphBase

applyCharacterFormat, applyStyle, getAncestor, getOwnerParagraph, getStyleName, isDeleteRevision, isInsertRevision

Methods inherited from class com.spire.doc.DocumentObject

deepClone, getFirstChild, getLastChild, getNextSibling, getOwner, getPreviousSibling, isComposite, toString

Methods inherited from class com.spire.doc.OwnerHolder

getDocument

Methods inherited from interface com.spire.doc.interfaces.IDocumentObject

deepClone, getDocument, getNextSibling, getOwner, getPreviousSibling, isComposite

Methods inherited from interface com.spire.doc.documents.IRunAttrSource

clearRunAttrs, fetchInheritedRunAttr, getDirectRunAttr, getDirectRunAttrByIndex, getDirectRunAttrsCount, setRunAttr

Constructor Detail

ShapeObject

public ShapeObject(IDocument doc)

Ctor. Use this internally only.

Parameters:

doc - doc

ShapeObject

public ShapeObject(IDocument doc,
                   ShapeType shapeType)

Creates a new shape object.

Parameters:

doc - The owner document.

shapeType - The type of the shape to create.

Method Detail

getDocumentObjectType

public DocumentObjectType getDocumentObjectType()

Gets the type of the document object.

Specified by:

getDocumentObjectType in interface IDocumentObject

Overrides:

getDocumentObjectType in class ShapeBase

Returns:

The type of the document object.

getCharacterFormat

public CharacterFormat getCharacterFormat()

Gets shape object's character format.

Overrides:

getCharacterFormat in class ParagraphBase

Returns:

CharacterFormat

getFillColor

public java.awt.Color getFillColor()

Gets the brush color that fills the closed path of the shape. The default value is Color.WHITE

Returns:

color

setFillColor

public void setFillColor(java.awt.Color value)

Sets the brush color that fills the closed path of the shape.

Parameters:

value - Color

getStrokeWeight

public double getStrokeWeight()

Defines the brush thickness that strokes the path of a shape in points. The default value is 0.75.

Returns:

double

setStrokeWeight

public void setStrokeWeight(double value)

Defines the brush thickness that strokes the path of a shape in points.

Parameters:

value - double

getStrokeColor

public java.awt.Color getStrokeColor()

Gets the color of a stroke. The default value is Color.BLACK *

Returns:

Color

setStrokeColor

public void setStrokeColor(java.awt.Color value)

Sets the color of a stroke.

Parameters:

value - Color

getLineStyle

public ShapeLineStyle getLineStyle()

Gets the line style of the stroke.

The default value is ShapeLineStyle.Single

Returns:

ShapeLineStyle

setLineStyle

public void setLineStyle(ShapeLineStyle value)

Sets the line style of the stroke.

Parameters:

value - ShapeLineStyle

hasImage

public boolean hasImage()

Returns true if the shape has image bytes or links an image.

Returns:

boolean

getWordArt

public WordArt getWordArt()

Defines the text of the text path (of a WordArt object).

Returns:

WordArt

getChildObjects

public DocumentObjectCollection getChildObjects()

Description copied from class: ParagraphBase

Gets the child objects of the entity.

Specified by:

getChildObjects in interface ICompositeObject

Overrides:

getChildObjects in class ShapeBase

Returns:

DocumentObjectCollection