Apache POI - Common 5.3.0 · org.apache.poi.sl.draw.geom.Path

public final Class Path

Specifies a creation path consisting of a series of moves, lines and curves that when combined forms a geometric shape

Java class for CT_Path2D complex type.

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

<complexType name="CT_Path2D">
  <complexContent>
    <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
      <choice maxOccurs="unbounded" minOccurs="0">
        <element name="close" type="{http://schemas.openxmlformats.org/drawingml/2006/main}CT_Path2DClose"/>
        <element name="moveTo" type="{http://schemas.openxmlformats.org/drawingml/2006/main}CT_Path2DMoveTo"/>
        <element name="lnTo" type="{http://schemas.openxmlformats.org/drawingml/2006/main}CT_Path2DLineTo"/>
        <element name="arcTo" type="{http://schemas.openxmlformats.org/drawingml/2006/main}CT_Path2DArcTo"/>
        <element name="quadBezTo" type="{http://schemas.openxmlformats.org/drawingml/2006/main}CT_Path2DQuadBezierTo"/>
        <element name="cubicBezTo" type="{http://schemas.openxmlformats.org/drawingml/2006/main}CT_Path2DCubicBezierTo"/>
      </choice>
      <attribute name="w" type="{http://schemas.openxmlformats.org/drawingml/2006/main}ST_PositiveCoordinate" default="0" />
      <attribute name="h" type="{http://schemas.openxmlformats.org/drawingml/2006/main}ST_PositiveCoordinate" default="0" />
      <attribute name="fill" type="{http://schemas.openxmlformats.org/drawingml/2006/main}ST_PathFillMode" default="norm" />
      <attribute name="stroke" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" />
      <attribute name="extrusionOk" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" />
    </restriction>
  </complexContent>
</complexType>

Field Summary

Modifier and Type	Field and Description
private final List<PathCommand>	commands
private boolean	extrusionOk
private PaintStyle.PaintModifier	fill
private long	h
private boolean	stroke
private long	w

Constructor Summary

Access	Constructor and Description
public	Path()

Modifier and Type	Method and Description
public void	addCommand(PathCommand cmd) Implements org.apache.poi.sl.draw.geom.PathIf.addCommand.
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 PaintStyle.PaintModifier	getFill() Implements org.apache.poi.sl.draw.geom.PathIf.getFill.
public long	getH() Implements org.apache.poi.sl.draw.geom.PathIf.getH.
public Path2D.Double	getPath(Context ctx) Implements org.apache.poi.sl.draw.geom.PathIf.getPath. Convert the internal represenation to java.awt.geom.Path2D
public long	getW() Implements org.apache.poi.sl.draw.geom.PathIf.getW.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public boolean	isExtrusionOk() Implements org.apache.poi.sl.draw.geom.PathIf.isExtrusionOk.
public boolean	isFilled() Implements org.apache.poi.sl.draw.geom.PathIf.isFilled.
public boolean	isStroked() Implements org.apache.poi.sl.draw.geom.PathIf.isStroked.
public void	setExtrusionOk(boolean extrusionOk) Implements org.apache.poi.sl.draw.geom.PathIf.setExtrusionOk.
public void	setFill(PaintStyle.PaintModifier fill) Implements org.apache.poi.sl.draw.geom.PathIf.setFill.
public void	setH(long h) Implements org.apache.poi.sl.draw.geom.PathIf.setH.
public void	setStroke(boolean stroke) Implements org.apache.poi.sl.draw.geom.PathIf.setStroke.
public void	setW(long w) Implements org.apache.poi.sl.draw.geom.PathIf.setW.

Modifier and Type

Method and Description

public void

addCommand(PathCommand cmd)

Implements org.apache.poi.sl.draw.geom.PathIf.addCommand.

public boolean

equals(Object

the reference object with which to compare.

Overrides java.lang.Object.equals.

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

public PaintStyle.PaintModifier

getFill()

Implements org.apache.poi.sl.draw.geom.PathIf.getFill.

public long

getH()

Implements org.apache.poi.sl.draw.geom.PathIf.getH.

public Path2D.Double

getPath(Context ctx)

Implements org.apache.poi.sl.draw.geom.PathIf.getPath.

Convert the internal represenation to java.awt.geom.Path2D

public long

getW()

Implements org.apache.poi.sl.draw.geom.PathIf.getW.

public int

hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public boolean

isExtrusionOk()

Implements org.apache.poi.sl.draw.geom.PathIf.isExtrusionOk.

public boolean

isFilled()

Implements org.apache.poi.sl.draw.geom.PathIf.isFilled.

public boolean

isStroked()

Implements org.apache.poi.sl.draw.geom.PathIf.isStroked.

public void

setExtrusionOk(boolean extrusionOk)

Implements org.apache.poi.sl.draw.geom.PathIf.setExtrusionOk.

public void

setFill(PaintStyle.PaintModifier fill)

Implements org.apache.poi.sl.draw.geom.PathIf.setFill.

public void

setH(long h)

Implements org.apache.poi.sl.draw.geom.PathIf.setH.

public void

setStroke(boolean stroke)

Implements org.apache.poi.sl.draw.geom.PathIf.setStroke.

public void

setW(long w)

Implements org.apache.poi.sl.draw.geom.PathIf.setW.

Field Detail

commands	back to summary
private final List<PathCommand> commands

extrusionOk	back to summary
private boolean extrusionOk

fill	back to summary
private PaintStyle.PaintModifier fill

h	back to summary
private long h

stroke	back to summary
private boolean stroke

w	back to summary
private long w

Constructor Detail

Path	back to summary
public Path()

Method Detail

addCommand	back to summary
public void addCommand(PathCommand cmd) Implements org.apache.poi.sl.draw.geom.PathIf.addCommand. Annotations @Override

addCommand

back to summary

public void addCommand(PathCommand cmd)

Implements org.apache.poi.sl.draw.geom.PathIf.addCommand.

Annotations

@Override

equals back to summary

equals	back 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

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

getFill	back to summary
public PaintStyle.PaintModifier getFill() Implements org.apache.poi.sl.draw.geom.PathIf.getFill. Annotations @Override

getFill

back to summary

public PaintStyle.PaintModifier getFill()

Implements org.apache.poi.sl.draw.geom.PathIf.getFill.

Annotations

@Override

getH	back to summary
public long getH() Implements org.apache.poi.sl.draw.geom.PathIf.getH. Annotations @Override

getH

back to summary

public long getH()

Implements org.apache.poi.sl.draw.geom.PathIf.getH.

Annotations

@Override

getPath	back to summary
public Path2D.Double getPath(Context ctx) Implements org.apache.poi.sl.draw.geom.PathIf.getPath. Convert the internal represenation to java.awt.geom.Path2D Annotations @Override

getPath

back to summary

public Path2D.Double getPath(Context ctx)

Implements org.apache.poi.sl.draw.geom.PathIf.getPath.

Convert the internal represenation to java.awt.geom.Path2D

Annotations

@Override

getW	back to summary
public long getW() Implements org.apache.poi.sl.draw.geom.PathIf.getW. Annotations @Override

getW

back to summary

public long getW()

Implements org.apache.poi.sl.draw.geom.PathIf.getW.

Annotations

@Override

hashCode back to summary

hashCode	back 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

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