Package com.priint.pubserver.metadata.base

Interface DocumentElement

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

Element, Frame, Group, Placeholder

All Known Implementing Classes:

DocumentElementImpl, ElementImpl, FrameImpl, FrameImpl, GroupImpl, ParagraphImpl, PlaceholderImpl

public interface DocumentElement
extends java.io.Serializable

Interface for the element xml type and base interface for derived types.

Interface for the element xml type and base interface for derived types
This interface describes properties common to types, which describe an element or item in a document.
Implemented in DocumentElementImpl
Derived types are

• Element
• Placeholder
• Group

Method Summary

Modifier and Type	Method	Description
int	getId()	Gets the Id of this element.
double	getSizeAbsolute()	Gets the size of this element.
java.lang.String	getSizeRelative()	Gets the size of this element.
double	getVisibleSizeAbsolute()	Gets the visible size of this element.
java.lang.String	getVisibleSizeRelative()	Gets the visible size of this element.
void	setId(int id)	Sets the Id of the element.
void	setSizeAbsolute(double sizeAbsolute)	Sets the size of this element.
void	setSizeRelative(java.lang.String sizeRelative)	Sets the size of this element.
void	setVisibleSizeAbsolute(double visibleSizeAbsolute)	Sets the visible size of this element.
void	setVisibleSizeRelative(java.lang.String visibleSizeRelative)	Sets the visible size of this element.

Method Detail

getId

int getId()

Gets the Id of this element.

Gets the Id of this element.
This Id is guaranteed to be unique within a particular document. Unless the document content changes, the Id is also guaranteed to be persistent.
For certain element types (such as Group), the Id is also guaranteed to be persistent as long as a (semantically) identical element exists in the document.

Returns:

the Id of this element

setId

void setId(int id)

Sets the Id of the element.

Sets the Id of this element. For further information see getId()

Parameters:

id - Id of the element

getVisibleSizeRelative

java.lang.String getVisibleSizeRelative()

Gets the visible size of this element.

Gets the visible size relative to the page (not the spread!) size of this element.
Calculation of the size is based on the area of the element, which is not covered, overlapped or whatsoever by any other element on that page.

Returns:

relative visible size of this element

setVisibleSizeRelative

void setVisibleSizeRelative(java.lang.String visibleSizeRelative)

Sets the visible size of this element.

Sets the visible size of this element. For further information see getVisibleSizeRelative()

Parameters:

visibleSizeRelative - relative visible size of this element

getVisibleSizeAbsolute

double getVisibleSizeAbsolute()

Gets the visible size of this element.

Gets the absolute visible size of this element.
As all absolute size specifications are based on pt, the size is given in "squarepoints". Calculation of the size is based on the area of the element, which is not covered, overlapped or whatsoever by any other element on that page.

Returns:

absolute visible size of this element

setVisibleSizeAbsolute

void setVisibleSizeAbsolute(double visibleSizeAbsolute)

Sets the visible size of this element.

Sets the visible size of this element. For further information see getVisibleSizeAbsolute()

Parameters:

visibleSizeAbsolute - absolute visible size of this element

getSizeRelative

java.lang.String getSizeRelative()

Gets the size of this element.

Gets the size relative to the page (not the spread!) size of this element.
Calculation of the size is based on the entire area covered by this element.

Returns:

relative size of this element

setSizeRelative

void setSizeRelative(java.lang.String sizeRelative)

Sets the size of this element.

Sets the size of this element. For further information see getSizeRelative()

Parameters:

sizeRelative - relative size of this element

getSizeAbsolute

double getSizeAbsolute()

Gets the size of this element.

Gets the absolute size of this element.
As all absolute size specifications are based on pt, the size is given in "squarepoints". Calculation of the size is based on the entire area covered by this element.

Returns:

absolute size of this element

setSizeAbsolute

void setSizeAbsolute(double sizeAbsolute)

Sets the size of this element.

Sets the size of this element. For further information see getSizeAbsolute()

Parameters:

sizeAbsolute - absolute size of this element