Element
implements DocumentElement| com.priint.comet.metadata.element.Element |
Class Overview
Interface for the element xml type
Interface for the element xml type, implemented
in ElementImpl.
An element describes an item (usually frame) in a document.
Summary
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| abstract Area |
getArea()
Gets the area of this element. | ||||||||||
| abstract BBox |
getBbox()
Gets the bbox of this element. | ||||||||||
| abstract boolean |
getChainHasOverset()
Gets, whether there is overset in any of the elements in chain. | ||||||||||
| abstract int |
getChainNext()
Gets the next element in the chain . | ||||||||||
| abstract int |
getChainParentId()
Gets the chain parent id.
| ||||||||||
| abstract int |
getChainPrevious()
Gets the previous element in the chain . | ||||||||||
| abstract int |
getColumns()
Gets the number of columns of this element. | ||||||||||
| abstract Ext |
getExt()
Gets the external reference of this element. | ||||||||||
| abstract FittingOptions |
getFittingOptions()
Gets the fitting options.
| ||||||||||
| abstract double |
getGutter()
Gets the gutter of this element. | ||||||||||
| abstract int |
getIdGroupId()
Gets the InDesign group Id of this element. | ||||||||||
| abstract List<IDLabel> |
getIdlabels()
Gets the idlabels.
| ||||||||||
| abstract IDTag |
getIdtag()
Gets the idtag.
| ||||||||||
| abstract ImageContent |
getImagecontent()
Gets the imagecontent.
| ||||||||||
| abstract double |
getInsetBottom()
Gets the bottom inset of this element. | ||||||||||
| abstract double |
getInsetLeft()
Gets the left inset of this element. | ||||||||||
| abstract double |
getInsetRight()
Gets the right inset of this element. | ||||||||||
| abstract double |
getInsetTop()
Gets the top inset of this element. | ||||||||||
| abstract int |
getInteractive()
Gets the interactive.
| ||||||||||
| abstract int |
getLocked()
Gets the locked.
| ||||||||||
| abstract int |
getObjectstyle()
Gets the objectstyle.
| ||||||||||
| abstract Origin |
getOrigin()
Gets origin of this element. | ||||||||||
| abstract String |
getOriginInMaster()
Gets the origin in master.
| ||||||||||
| abstract int |
getOriginUid()
Gets the origin uid.
| ||||||||||
| abstract Parents |
getParents()
Gets parents of this element. | ||||||||||
| abstract ElementProperties |
getProperties()
Gets the properties.
| ||||||||||
| abstract Record |
getRecord()
Gets the record linked to this element. | ||||||||||
| abstract int |
getSequence()
Gets the sequence.
| ||||||||||
| abstract TextContent |
getTextcontent()
Gets the textcontent.
| ||||||||||
| abstract int |
getTextmodel()
Gets the textmodel.
| ||||||||||
| abstract ElementType |
getType()
Gets the type of this element. | ||||||||||
| abstract String |
getUitype()
Gets the uitype.
| ||||||||||
| abstract int |
getVerticalJustification()
Gets the vertical justification.
| ||||||||||
| abstract boolean |
isVisible()
Checks if is visible.
| ||||||||||
| abstract void |
setArea(Area area)
Sets the area of this element. | ||||||||||
| abstract void |
setBbox(BBox bbox)
Sets the bbox of this element. | ||||||||||
| abstract void |
setChainHasOverset(boolean chainHasOverset)
Sets, whether there is overset in any of the elements in chain. | ||||||||||
| abstract void |
setChainNext(int chainNext)
Sets the next element in chain. | ||||||||||
| abstract void |
setChainParentId(int chainParentId)
Sets the chain parent id.
| ||||||||||
| abstract void |
setChainPrevious(int chainPrevious)
Sets the previous element in chain. | ||||||||||
| abstract void |
setColumns(int columns)
Sets the number of columns of this element. | ||||||||||
| abstract void |
setExt(Ext ext)
Sets the external reference of this element. | ||||||||||
| abstract void |
setFittingOptions(FittingOptions fittingOptions)
Sets the fitting options.
| ||||||||||
| abstract void |
setGutter(double gutter)
Sets the gutter of this element. | ||||||||||
| abstract void |
setIdGroupId(int idGroupId)
Sets the InDesign group Id of this element. | ||||||||||
| abstract void |
setIdlabels(List<IDLabel> idlabels)
Sets the idlabels.
| ||||||||||
| abstract void |
setIdtag(IDTag idtag)
Sets the idtag.
| ||||||||||
| abstract void |
setImagecontent(ImageContent imagecontent)
Sets the imagecontent.
| ||||||||||
| abstract void |
setInsetBottom(double insetBottom)
Sets the bottom inset of this element. | ||||||||||
| abstract void |
setInsetLeft(double insetLeft)
Sets the left inset of this element. | ||||||||||
| abstract void |
setInsetRight(double insetRight)
Sets the right inset of this element. | ||||||||||
| abstract void |
setInsetTop(double insetTop)
Sets the top inset of this element. | ||||||||||
| abstract void |
setInteractive(int interactive)
Sets the interactive.
| ||||||||||
| abstract void |
setLocked(int locked)
Sets the locked.
| ||||||||||
| abstract void |
setObjectstyle(int objectstyle)
Sets the objectstyle.
| ||||||||||
| abstract void |
setOrigin(Origin origin)
Sets the origin of this element. | ||||||||||
| abstract void |
setOriginInMaster(String originInMaster)
Sets the origin in master.
| ||||||||||
| abstract void |
setOriginUid(int originUid)
Sets the origin uid.
| ||||||||||
| abstract void |
setParents(Parents parents)
Sets parents of this element. | ||||||||||
| abstract void |
setProperties(ElementProperties properties)
Sets the properties.
| ||||||||||
| abstract void |
setRecord(Record record)
Sets the record linked to this element. | ||||||||||
| abstract void |
setSequence(int sequence)
Sets the sequence.
| ||||||||||
| abstract void |
setTextcontent(TextContent textcontent)
Sets the textcontent.
| ||||||||||
| abstract void |
setTextmodel(int textmodel)
Sets the textmodel.
| ||||||||||
| abstract void |
setType(ElementType type)
Sets the type of this element. | ||||||||||
| abstract void |
setUitype(String uitype)
Sets the uitype.
| ||||||||||
| abstract void |
setVerticalJustification(int verticalJustification)
Sets the vertical justification.
| ||||||||||
| abstract void |
setVisible(boolean visible)
Sets the visible.
| ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From interface
com.priint.comet.metadata.base.DocumentElement
| |||||||||||
Public Methods
public abstract Area getArea ()
Gets the area of this element.
Gets the area of this element, see the
Area interface for
further information
Returns
- area of this element.
public abstract BBox getBbox ()
Gets the bbox of this element.
Gets the bbox of this element, see the
BBox interface for
further information
Returns
- bbox of this element.
public abstract boolean getChainHasOverset ()
Gets, whether there is overset in any of the elements in chain.
Returns
- true, if there is overset, false otherwise
public abstract int getChainNext ()
Gets the next element in the chain
.Returns
- ID of next element in chain, 0, if no next element exists
public abstract int getChainParentId ()
Gets the chain parent id.
Returns
- chainParentId
public abstract int getChainPrevious ()
Gets the previous element in the chain
.Returns
- ID of previous element in chain, 0, if no previous element exists
public abstract int getColumns ()
Gets the number of columns of this element.
Gets the number of text columns of this element.
Returns
- number of columns
public abstract Ext getExt ()
Gets the external reference of this element.
Gets the external reference of this element. See
the Ext interface
for further information.
Returns
- external reference of this element
public abstract FittingOptions getFittingOptions ()
Gets the fitting options.
Returns
- the fitting options
public abstract double getGutter ()
Gets the gutter of this element.
Gets the gutter, i.e. padding between columns, of this element.
Returns
- gutter of this element
public abstract int getIdGroupId ()
Gets the InDesign group Id of this element.
Gets the InDesign group Id of this element (rather
than the CometGroup Id).
The InDesign group Id is a pure layout element with no
further semantic meaning, applicable in InDesign documents
only and not required for any element.
Returns
- InDesign group Id of this element, if applicable
public abstract double getInsetBottom ()
Gets the bottom inset of this element.
Gets the bottom inset (aka padding) of this element.
Returns
- bottom inset of this element
public abstract double getInsetLeft ()
Gets the left inset of this element.
Gets the left inset (aka padding) of this element.
Returns
- left inset of this element
public abstract double getInsetRight ()
Gets the right inset of this element.
Gets the right inset (aka padding) of this element.
Returns
- right inset of this element
public abstract double getInsetTop ()
Gets the top inset of this element.
Gets the top inset (aka padding) of this element.
Returns
- top inset of this element
public abstract int getInteractive ()
Gets the interactive.
Returns
- interactive
public abstract int getLocked ()
Gets the locked.
Returns
- locked
public abstract int getObjectstyle ()
Gets the objectstyle.
Returns
- objectstyle
public abstract Origin getOrigin ()
Gets origin of this element.
Gets origin of this element, i.e masterpage or regular page.
Returns
- origin of this documnet
public abstract String getOriginInMaster ()
Gets the origin in master.
Returns
- originInMaster
public abstract int getOriginUid ()
Gets the origin uid.
Returns
- originUid
public abstract Parents getParents ()
Gets parents of this element.
Gets parents of this element. See
the Parents interface
for further information.
Returns
- parents of this element
public abstract Record getRecord ()
Gets the record linked to this element.
Gets the record linked to this element. See
the Record interface
for further information.
Returns
- record linked to this element
public abstract int getSequence ()
Gets the sequence.
Returns
- sequence
public abstract int getTextmodel ()
Gets the textmodel.
Returns
- textmodel
public abstract ElementType getType ()
Gets the type of this element.
Gets the type of this element, i.e. graphic frame, text frame or image frame.
Returns
- type of this element
public abstract String getUitype ()
Gets the uitype.
Returns
- uitype
public abstract int getVerticalJustification ()
Gets the vertical justification.
Returns
- verticalJustification
public abstract boolean isVisible ()
Checks if is visible.
Returns
- visible
public abstract void setArea (Area area)
Sets the area of this element.
Sets the area of this element, see the
Area interface for
further information
Parameters
| area | area of this element. |
|---|
public abstract void setBbox (BBox bbox)
Sets the bbox of this element.
Sets the bbox of this element, see the
BBox interface for
further information
Parameters
| bbox | bbox of this element. |
|---|
public abstract void setChainHasOverset (boolean chainHasOverset)
Sets, whether there is overset in any of the elements in chain.
Parameters
| chainHasOverset | true, if there is overset, false otherwise. |
|---|
public abstract void setChainNext (int chainNext)
Sets the next element in chain.
Parameters
| chainNext | next element in chain, 0, if no next element exists |
|---|
public abstract void setChainParentId (int chainParentId)
Sets the chain parent id.
Parameters
| chainParentId | the chainParentId property to set |
|---|
public abstract void setChainPrevious (int chainPrevious)
Sets the previous element in chain.
Parameters
| chainPrevious | previous element in chain, 0, if no previous element exists |
|---|
public abstract void setColumns (int columns)
Sets the number of columns of this element.
Sets the number of text columns of this element.
Parameters
| columns | number of columns of this element |
|---|
public abstract void setExt (Ext ext)
Sets the external reference of this element.
Sets the external reference of this element. See getExt()
for further information.
Parameters
| ext | the external reference of this element |
|---|
public abstract void setFittingOptions (FittingOptions fittingOptions)
Sets the fitting options.
Parameters
| fittingOptions | the new fitting options |
|---|
public abstract void setGutter (double gutter)
Sets the gutter of this element.
Sets the gutter, i.e. padding between columns, of this element.
Parameters
| gutter | gutter of this element |
|---|
public abstract void setIdGroupId (int idGroupId)
Sets the InDesign group Id of this element.
Sets the InDesign group Id of this element, see getIdGroupId()
for further information.
Parameters
| idGroupId | InDesign group Id of this element, if applicable |
|---|
public abstract void setIdlabels (List<IDLabel> idlabels)
Sets the idlabels.
Parameters
| idlabels | the new idlabels |
|---|
public abstract void setImagecontent (ImageContent imagecontent)
Sets the imagecontent.
Parameters
| imagecontent | the imagecontent to set |
|---|
public abstract void setInsetBottom (double insetBottom)
Sets the bottom inset of this element.
Sets the bottom inset (aka padding) of this element.
Parameters
| insetBottom | the new inset bottom |
|---|
public abstract void setInsetLeft (double insetLeft)
Sets the left inset of this element.
Sets the left inset (aka padding) of this element.
Parameters
| insetLeft | left inset of this element |
|---|
public abstract void setInsetRight (double insetRight)
Sets the right inset of this element.
Sets the right inset (aka padding) of this element.
Parameters
| insetRight | right inset of this element |
|---|
public abstract void setInsetTop (double insetTop)
Sets the top inset of this element.
Sets the top inset (aka padding) of this element.
Parameters
| insetTop | top inset of this element |
|---|
public abstract void setInteractive (int interactive)
Sets the interactive.
Parameters
| interactive | the interactive property to set |
|---|
public abstract void setLocked (int locked)
Sets the locked.
Parameters
| locked | the locked property to set |
|---|
public abstract void setObjectstyle (int objectstyle)
Sets the objectstyle.
Parameters
| objectstyle | the objectstyle property to set |
|---|
public abstract void setOrigin (Origin origin)
Sets the origin of this element.
Sets the origin of this element.
Parameters
| origin | origin of this element. |
|---|
public abstract void setOriginInMaster (String originInMaster)
Sets the origin in master.
Parameters
| originInMaster | the originInMaster property to set |
|---|
public abstract void setOriginUid (int originUid)
Sets the origin uid.
Parameters
| originUid | the originUid property to set |
|---|
public abstract void setParents (Parents parents)
Sets parents of this element.
Sets parents this element. See getParents()
for further information.
Parameters
| parents | of this element |
|---|
public abstract void setProperties (ElementProperties properties)
Sets the properties.
Parameters
| properties | the properties to set |
|---|
public abstract void setRecord (Record record)
Sets the record linked to this element.
Sets the record linked to this element. See getRecord()
for further information.
Parameters
| record | the new record |
|---|
public abstract void setSequence (int sequence)
Sets the sequence.
Parameters
| sequence | the sequence property to set |
|---|
public abstract void setTextcontent (TextContent textcontent)
Sets the textcontent.
Parameters
| textcontent | the new textcontent |
|---|
public abstract void setTextmodel (int textmodel)
Sets the textmodel.
Parameters
| textmodel | the textmodel property to set |
|---|
public abstract void setType (ElementType type)
Sets the type of this element.
Sets the type of this element, see getType() for
further information.
Parameters
| type | type of this element |
|---|
public abstract void setUitype (String uitype)
Sets the uitype.
Parameters
| uitype | the uitype property to set |
|---|
public abstract void setVerticalJustification (int verticalJustification)
Sets the vertical justification.
Parameters
| verticalJustification | the verticalJustification property to set |
|---|
public abstract void setVisible (boolean visible)
Sets the visible.
Parameters
| visible | the visible property to set |
|---|