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.shapes.ShapeBase
                          com.spire.doc.fields.shapes.Shape
                              com.spire.doc.fields.ShapeObject

All Implemented Interfaces:

IDocumentObject, IDocumentSerializable, IParagraphBase

Direct Known Subclasses:

DocOleObject, DocPicture, TextBox

public class ShapeObject
extends Shape

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.
Chart	getChart() Returns a chart object.
DocumentObjectCollection	getChildObjects() Gets the child objects of the entity.
DocumentObjectType	getDocumentObjectType() Gets the type of the document object.
boolean	getExtrusionEnabled()
java.awt.Color	getFillColor() Defines the brush color that fills the closed path of the shape.
LineDashing	getLineDashing() Defines the line dashing of the stroke.
ShapeLineStyle	getLineStyle() Defines the line style of the stroke.
boolean	getShadowEnabled()
java.awt.Color	getStrokeColor() Defines 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).
void	setFillColor(java.awt.Color value) Defines the brush color that fills the closed path of the shape.
void	setFillTransparency(double value) Set the fill transparency of the shape.
void	setLineDashing(LineDashing value) Defines the line dashing of the stroke.
void	setLineStyle(ShapeLineStyle value) Defines the line style of the stroke.
void	setStrokeColor(java.awt.Color value) Defines 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.shapes.Shape

getFirstParagraph, getLastParagraph, hasChart, hasImage

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

adjustWithEffects, getAllowOverlap, getAlternativeText, getAspectRatioLocked, getBehindText, getBottom, getCoordOrigin, getCoordSize, getDistanceBottom, getDistanceLeft, getDistanceRight, getDistanceTop, getFill, getHeight, getHorizontalAlignment, getHorizontalOrigin, getHorizontalPosition, getRight, getRotation, getShapeType, getSize, getTextWrappingStyle, getTextWrappingType, getVerticalAlignment, getVerticalOrigin, getVerticalPosition, getWidth, getWrapType, getZOrder, isHidden, isHidden, isSignatureLine, localToParent, setAllowOverlap, setAlternativeText, setAspectRatioLocked, setBehindText, setCoordOrigin, setCoordSize, setDistanceBottom, setDistanceLeft, setDistanceRight, setDistanceTop, setHeight, setHorizontalAlignment, setHorizontalOrigin, setHorizontalPosition, setRotation, setShapeType, setTextWrappingStyle, setTextWrappingType, setVerticalAlignment, setVerticalOrigin, setVerticalPosition, setWidth, setWrapType, setZOrder

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

applyCharacterFormat, applyStyle, getDeleteRevision, getInsertRevision, getNextWidgetSibling, getOwnerParagraph, getPreviousWidgetSibling, getStyleName, isDeleteRevision, isInsertRevision

Methods inherited from class com.spire.doc.DocumentObject

deepClone, getFirstChild, getLastChild, getNextSibling, getOwner, getPreviousSibling, isComposite, prependChild, 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

Constructor Detail

ShapeObject

public ShapeObject(IDocument doc)

Ctor. Use this internally only.

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

getChart

public Chart getChart()

Returns a chart object. If there is a chart associated with this shape, it allows for the manipulation of chart.

getDocumentObjectType

public DocumentObjectType getDocumentObjectType()

Gets the type of the document object.

Specified by:

getDocumentObjectType in interface IDocumentObject

Overrides:

getDocumentObjectType in class Shape

Returns:

The type of the document object.

getCharacterFormat

public CharacterFormat getCharacterFormat()

Gets shape object's character format.

Overrides:

getCharacterFormat in class ParagraphBase

Returns:

The paragraph item character format.

getFillColor

public java.awt.Color getFillColor()

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

The default value is . .

Overrides:

getFillColor in class Shape

setFillColor

public void setFillColor(java.awt.Color value)

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

The default value is . .

Overrides:

setFillColor in class Shape

setFillTransparency

public void setFillTransparency(double value)

Set the fill transparency of the shape.

getStrokeWeight

public double getStrokeWeight()

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

The default value is 0.75.

Overrides:

getStrokeWeight in class Shape

setStrokeWeight

public void setStrokeWeight(double value)

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

The default value is 0.75.

Overrides:

setStrokeWeight in class Shape

getStrokeColor

public java.awt.Color getStrokeColor()

Defines the color of a stroke.

The default value is . .

Overrides:

getStrokeColor in class Shape

setStrokeColor

public void setStrokeColor(java.awt.Color value)

Defines the color of a stroke.

The default value is . .

Overrides:

setStrokeColor in class Shape

getLineStyle

public ShapeLineStyle getLineStyle()

Defines the line style of the stroke.

The default value is .

setLineStyle

public void setLineStyle(ShapeLineStyle value)

Defines the line style of the stroke.

The default value is .

getLineDashing

public LineDashing getLineDashing()

Defines the line dashing of the stroke.

setLineDashing

public void setLineDashing(LineDashing value)

Defines the line dashing of the stroke.

getWordArt

public WordArt getWordArt()

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

getExtrusionEnabled

public boolean getExtrusionEnabled()

Overrides:

getExtrusionEnabled in class Shape

getShadowEnabled

public boolean getShadowEnabled()

Overrides:

getShadowEnabled in class Shape

getChildObjects

public DocumentObjectCollection getChildObjects()

Gets the child objects of the entity.

Overrides:

getChildObjects in class ShapeBase