Top Description Fields Constructors Methods
org.apache.poi.sl.draw.geom

public final Class CustomGeometry

extends Object
implements Iterable<PathIf>
Class Inheritance
All Implemented Interfaces
java.lang.Iterable
Imports
java.util.ArrayList, .Iterator, .List, .Objects, .Spliterator
Definition of a custom geometric shape

Java class for CT_CustomGeometry2D complex type.

The following schema fragment specifies the expected content contained within this class. 

<complexType name="CT_CustomGeometry2D">
  <complexContent>
    <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
      <sequence>
        <element name="avLst" type="{http://schemas.openxmlformats.org/drawingml/2006/main}CT_GeomGuideList" minOccurs="0"/>
        <element name="gdLst" type="{http://schemas.openxmlformats.org/drawingml/2006/main}CT_GeomGuideList" minOccurs="0"/>
        <element name="ahLst" type="{http://schemas.openxmlformats.org/drawingml/2006/main}CT_AdjustHandleList" minOccurs="0"/>
        <element name="cxnLst" type="{http://schemas.openxmlformats.org/drawingml/2006/main}CT_ConnectionSiteList" minOccurs="0"/>
        <element name="rect" type="{http://schemas.openxmlformats.org/drawingml/2006/main}CT_GeomRect" minOccurs="0"/>
        <element name="pathLst" type="{http://schemas.openxmlformats.org/drawingml/2006/main}CT_Path2DList"/>
      </sequence>
    </restriction>
  </complexContent>
</complexType>

Field Summary

Modifier and TypeField and Description
pack-priv final List<AdjustValueIf>
adjusts

pack-priv final List<ConnectionSiteIf>
connections

pack-priv final List<GuideIf>
guides

pack-priv final List<AdjustHandle>
handles

pack-priv final List<PathIf>
paths

pack-priv Path
textBounds

Constructor Summary

AccessConstructor and Description
public
CustomGeometry()

Method Summary

Modifier and TypeMethod and Description
public void
addAdjustGuide(AdjustValueIf guide)

public void
addAdjustHandle(AdjustHandle handle)

public void
addConnectionSite(ConnectionSiteIf connection)

public void
addGeomGuide(GuideIf guide)

public void
addPath(PathIf path)

public boolean
equals(Object
the reference object with which to compare.
o)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

public Path
getTextBounds()

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public Iterator<PathIf>
iterator()

Implements java.lang.Iterable.iterator.

Returns an iterator over elements of type T.

private static LineToCommand
lineTo(String x, String y)

private static MoveToCommand
moveTo(String x, String y)

public void
setTextBounds(String left, String top, String right, String bottom)

public Spliterator<PathIf>
spliterator()

Overrides default java.lang.Iterable.spliterator.

Creates a Spliterator over the elements described by this Iterable.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAlltoStringwaitwaitwait

Field Detail

adjustsback to summary
pack-priv final List<AdjustValueIf> adjusts
connectionsback to summary
pack-priv final List<ConnectionSiteIf> connections
guidesback to summary
pack-priv final List<GuideIf> guides
handlesback to summary
pack-priv final List<AdjustHandle> handles
pathsback to summary
pack-priv final List<PathIf> paths
textBoundsback to summary
pack-priv Path textBounds

Constructor Detail

CustomGeometryback to summary
public CustomGeometry()

Method Detail

addAdjustGuideback to summary
public void addAdjustGuide(AdjustValueIf guide)
addAdjustHandleback to summary
public void addAdjustHandle(AdjustHandle handle)
addConnectionSiteback to summary
public void addConnectionSite(ConnectionSiteIf connection)
addGeomGuideback to summary
public void addGeomGuide(GuideIf guide)
addPathback to summary
public void addPath(PathIf path)
equalsback to summary
public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
o:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
getTextBoundsback to summary
public Path getTextBounds()
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object

Annotations
@Override
iteratorback to summary
public Iterator<PathIf> iterator()

Implements java.lang.Iterable.iterator.

Doc from java.lang.Iterable.iterator.

Returns an iterator over elements of type T.

Returns:Iterator<PathIf>

an Iterator.

Annotations
@Override
lineToback to summary
private static LineToCommand lineTo(String x, String y)
moveToback to summary
private static MoveToCommand moveTo(String x, String y)
setTextBoundsback to summary
public void setTextBounds(String left, String top, String right, String bottom)
spliteratorback to summary
public Spliterator<PathIf> spliterator()

Overrides default java.lang.Iterable.spliterator.

Doc from java.lang.Iterable.spliterator.

Creates a Spliterator over the elements described by this Iterable.

Returns:Spliterator<PathIf>

a Spliterator over the elements described by this Iterable.

Annotations
@Override
Since
POI 5.2.0