Top Fields Constructors Methods
org.apache.poi.hssf.usermodel

public final Class HSSFChildAnchor

extends HSSFAnchor
Class Inheritance
Imports
org.apache.poi.ddf.EscherChildAnchorRecord, .EscherRecord

Field Summary

Modifier and TypeField and Description
private EscherChildAnchorRecord
_escherChildAnchor

Inherited from org.apache.poi.hssf.usermodel.HSSFAnchor:
_isHorizontallyFlipped_isVerticallyFlipped

Constructor Summary

AccessConstructor and Description
public
HSSFChildAnchor(EscherChildAnchorRecord escherChildAnchorRecord)

create anchor from existing file

public
HSSFChildAnchor()

public
HSSFChildAnchor(int
x coordinate of the left up corner
dx1, int
y coordinate of the left up corner
dy1, int
x coordinate of the right down corner
dx2, int
y coordinate of the right down corner
dy2)

create anchor from scratch

Method Summary

Modifier and TypeMethod and Description
protected void
createEscherAnchor()

Implements abstract org.apache.poi.hssf.usermodel.HSSFAnchor.createEscherAnchor.

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

Overrides java.lang.Object.equals.

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

public int
getDx1()

Implements org.apache.poi.ss.usermodel.ChildAnchor.getDx1.

public int
getDx2()

Implements org.apache.poi.ss.usermodel.ChildAnchor.getDx2.

public int
getDy1()

Implements org.apache.poi.ss.usermodel.ChildAnchor.getDy1.

public int
getDy2()

Implements org.apache.poi.ss.usermodel.ChildAnchor.getDy2.

protected EscherRecord
getEscherAnchor()

Implements abstract org.apache.poi.hssf.usermodel.HSSFAnchor.getEscherAnchor.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public boolean
isHorizontallyFlipped()

Implements abstract org.apache.poi.hssf.usermodel.HSSFAnchor.isHorizontallyFlipped.

public boolean
isVerticallyFlipped()

Implements abstract org.apache.poi.hssf.usermodel.HSSFAnchor.isVerticallyFlipped.

public void
setAnchor(int
x coordinate of the left up corner
dx1, int
y coordinate of the left up corner
dy1, int
x coordinate of the right down corner
dx2, int
y coordinate of the right down corner
dy2)

public void
setDx1(int
x coordinate of the left up corner
dx1)

Implements org.apache.poi.ss.usermodel.ChildAnchor.setDx1.

public void
setDx2(int
x coordinate of the right down corner
dx2)

Implements org.apache.poi.ss.usermodel.ChildAnchor.setDx2.

public void
setDy1(int
y coordinate of the left up corner
dy1)

Implements org.apache.poi.ss.usermodel.ChildAnchor.setDy1.

public void
setDy2(int
y coordinate of the right down corner
dy2)

Implements org.apache.poi.ss.usermodel.ChildAnchor.setDy2.

Inherited from org.apache.poi.hssf.usermodel.HSSFAnchor:
createAnchorFromEscher

Field Detail

_escherChildAnchorback to summary
private EscherChildAnchorRecord _escherChildAnchor

Constructor Detail

HSSFChildAnchorback to summary
public HSSFChildAnchor(EscherChildAnchorRecord escherChildAnchorRecord)

create anchor from existing file

HSSFChildAnchorback to summary
public HSSFChildAnchor()
HSSFChildAnchorback to summary
public HSSFChildAnchor(int dx1, int dy1, int dx2, int dy2)

create anchor from scratch

Parameters
dx1:int

x coordinate of the left up corner

dy1:int

y coordinate of the left up corner

dx2:int

x coordinate of the right down corner

dy2:int

y coordinate of the right down corner

Method Detail

createEscherAnchorback to summary
protected void createEscherAnchor()

Implements abstract org.apache.poi.hssf.usermodel.HSSFAnchor.createEscherAnchor.

Annotations
@Override
equalsback to summary
public boolean equals(Object obj)

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
obj: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
getDx1back to summary
public int getDx1()

Implements org.apache.poi.ss.usermodel.ChildAnchor.getDx1.

Returns:int

Doc from org.apache.poi.ss.usermodel.ChildAnchor.getDx1.

x coordinate of the left up corner

Annotations
@Override
getDx2back to summary
public int getDx2()

Implements org.apache.poi.ss.usermodel.ChildAnchor.getDx2.

Returns:int

Doc from org.apache.poi.ss.usermodel.ChildAnchor.getDx2.

x coordinate of the right down corner

Annotations
@Override
getDy1back to summary
public int getDy1()

Implements org.apache.poi.ss.usermodel.ChildAnchor.getDy1.

Returns:int

Doc from org.apache.poi.ss.usermodel.ChildAnchor.getDy1.

y coordinate of the left up corner

Annotations
@Override
getDy2back to summary
public int getDy2()

Implements org.apache.poi.ss.usermodel.ChildAnchor.getDy2.

Returns:int

Doc from org.apache.poi.ss.usermodel.ChildAnchor.getDy2.

y coordinate of the right down corner

Annotations
@Override
getEscherAnchorback to summary
protected EscherRecord getEscherAnchor()

Implements abstract org.apache.poi.hssf.usermodel.HSSFAnchor.getEscherAnchor.

Annotations
@Override
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
isHorizontallyFlippedback to summary
public boolean isHorizontallyFlipped()

Implements abstract org.apache.poi.hssf.usermodel.HSSFAnchor.isHorizontallyFlipped.

Returns:boolean

Doc from org.apache.poi.hssf.usermodel.HSSFAnchor.isHorizontallyFlipped.

whether this shape is horizontally flipped

Annotations
@Override
isVerticallyFlippedback to summary
public boolean isVerticallyFlipped()

Implements abstract org.apache.poi.hssf.usermodel.HSSFAnchor.isVerticallyFlipped.

Returns:boolean

Doc from org.apache.poi.hssf.usermodel.HSSFAnchor.isVerticallyFlipped.

whether this shape is vertically flipped

Annotations
@Override
setAnchorback to summary
public void setAnchor(int dx1, int dy1, int dx2, int dy2)
Parameters
dx1:int

x coordinate of the left up corner

dy1:int

y coordinate of the left up corner

dx2:int

x coordinate of the right down corner

dy2:int

y coordinate of the right down corner

setDx1back to summary
public void setDx1(int dx1)

Implements org.apache.poi.ss.usermodel.ChildAnchor.setDx1.

Parameters
dx1:int

Doc from org.apache.poi.ss.usermodel.ChildAnchor.setDx1.

x coordinate of the left up corner

Annotations
@Override
setDx2back to summary
public void setDx2(int dx2)

Implements org.apache.poi.ss.usermodel.ChildAnchor.setDx2.

Parameters
dx2:int

Doc from org.apache.poi.ss.usermodel.ChildAnchor.setDx2.

x coordinate of the right down corner

Annotations
@Override
setDy1back to summary
public void setDy1(int dy1)

Implements org.apache.poi.ss.usermodel.ChildAnchor.setDy1.

Parameters
dy1:int

Doc from org.apache.poi.ss.usermodel.ChildAnchor.setDy1.

y coordinate of the left up corner

Annotations
@Override
setDy2back to summary
public void setDy2(int dy2)

Implements org.apache.poi.ss.usermodel.ChildAnchor.setDy2.

Parameters
dy2:int

Doc from org.apache.poi.ss.usermodel.ChildAnchor.setDy2.

y coordinate of the right down corner

Annotations
@Override