org.opencms.gwt.client.util

类 CmsPositionBean

java.lang.Object

org.opencms.gwt.client.util.CmsPositionBean

public class CmsPositionBean
extends java.lang.Object

Bean holding the position data of a HTML DOM element.

从以下版本开始:

8.0.0

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	CmsPositionBean.Area Position area.

构造器概要

构造器

构造器和说明
CmsPositionBean() Constructor.
CmsPositionBean(CmsPositionBean model) Copy constructor.

方法概要

方法

限定符和类型	方法和说明
static CmsPositionBean	generatePositionInfo(com.google.gwt.dom.client.Element element) Collects the position information of the given UI object and returns a position info bean.
static CmsPositionBean	generatePositionInfo(com.google.gwt.user.client.ui.UIObject uiObject) Collects the position information of the given UI object and returns a position info bean.
CmsPositionBean.Area	getArea(int absLeft, int absTop, int offset) Returns over which area of this the given position is.
int	getHeight() Returns the height.
static CmsPositionBean	getInnerDimensions(com.google.gwt.dom.client.Element panel) Returns a position info representing the dimensions of all visible child elements of the given panel (excluding elements with position:absolute).
static CmsPositionBean	getInnerDimensions(com.google.gwt.dom.client.Element panel, int levels, boolean includeSelf) Returns a position info representing the dimensions of all visible child elements of the given panel (excluding elements with position:absolute).
int	getLeft() Returns the left.
int	getTop() Returns the top.
int	getWidth() Returns the width.
boolean	isOverElement(int absLeft, int absTop) Returns if given position is inside the position beans coordinates.
boolean	isOverTopHalf(int absTop) Returns if given absolute top is above the vertical middle of the position beans coordinates.
void	setHeight(int height) Sets the height.
void	setLeft(int left) Sets the left.
void	setTop(int top) Sets the top.
void	setWidth(int width) Sets the width.
java.lang.String	toString()

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

构造器详细资料

CmsPositionBean

public CmsPositionBean()

Constructor.

CmsPositionBean

public CmsPositionBean(CmsPositionBean model)

Copy constructor. Generating a copy of the given model.

参数:

model - the model to copy

方法详细资料

generatePositionInfo

public static CmsPositionBean generatePositionInfo(com.google.gwt.dom.client.Element element)

Collects the position information of the given UI object and returns a position info bean.

参数:

element - the object to read the position data from

返回:

the position data

generatePositionInfo

public static CmsPositionBean generatePositionInfo(com.google.gwt.user.client.ui.UIObject uiObject)

Collects the position information of the given UI object and returns a position info bean.

参数:

uiObject - the object to read the position data from

返回:

the position data

getInnerDimensions

public static CmsPositionBean getInnerDimensions(com.google.gwt.dom.client.Element panel)

Returns a position info representing the dimensions of all visible child elements of the given panel (excluding elements with position:absolute). If the panel has no visible child elements, it's outer dimensions are returned.

参数:

panel - the panel

返回:

the position info

getInnerDimensions

public static CmsPositionBean getInnerDimensions(com.google.gwt.dom.client.Element panel,
                                 int levels,
                                 boolean includeSelf)

Returns a position info representing the dimensions of all visible child elements of the given panel (excluding elements with position:absolute). If the panel has no visible child elements, it's outer dimensions are returned.

参数:

panel - the panel

levels - the levels to traverse down the DOM tree

includeSelf - true to include the outer dimensions of the given panel

返回:

the position info

getArea

public CmsPositionBean.Area getArea(int absLeft,
                           int absTop,
                           int offset)

Returns over which area of this the given position is. Will return null if the provided position is not within this position.

参数:

absLeft - the left position

absTop - the right position

offset - the border offset

返回:

the area

getHeight

public int getHeight()

Returns the height.

返回:

the height

getLeft

public int getLeft()

Returns the left.

返回:

the left

getTop

public int getTop()

Returns the top.

返回:

the top

getWidth

public int getWidth()

Returns the width.

返回:

the width

isOverElement

public boolean isOverElement(int absLeft,
                    int absTop)

Returns if given position is inside the position beans coordinates.

参数:

absLeft - the absolute left position

absTop - the absolute top position

返回:

true if the given position if within the beans coordinates

isOverTopHalf

public boolean isOverTopHalf(int absTop)

Returns if given absolute top is above the vertical middle of the position beans coordinates.

参数:

absTop - the absolute top position

返回:

true if given absolute top is above the vertical middle

setHeight

public void setHeight(int height)

Sets the height.

参数:

height - the height to set

setLeft

public void setLeft(int left)

Sets the left.

参数:

left - the left to set

setTop

public void setTop(int top)

Sets the top.

参数:

top - the top to set

setWidth

public void setWidth(int width)

Sets the width.

参数:

width - the width to set

toString

public java.lang.String toString()

覆盖:

toString 在类中 java.lang.Object

另请参阅:

Object.toString()