Interface Parents
-
- All Superinterfaces:
java.io.Serializable
- All Known Implementing Classes:
ParentsImpl
public interface Parents extends java.io.SerializableInterface for the parents xml type.
Interface for the parents xml type.
This interface describes the parents of an element, usually also described by the hierarchy of this element in the XML structure.
Implemented inParentsImpl
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.IntegergetGroupId()Gets the Id of the group, this element is part of.intgetInlinePosition()Gets the inline position.intgetLayoutGroup()Gets the layout group.java.lang.IntegergetPageId()Gets the Id (i.e.java.lang.IntegergetSpreadId()Gets the Id (i.e.intgetTableColumn()Gets the table column.intgetTableIndex()Gets the table index.intgetTableRow()Gets the table row.intgetTextmodel()Gets the textmodel.voidsetGroupId(java.lang.Integer groupId)Sets the Id of the group, this element is part of.voidsetInlinePosition(int inlinePosition)Sets the inline position.voidsetLayoutGroup(int layoutGroup)Sets the layout group.voidsetPageId(java.lang.Integer pageId)Sets the Id (i.e.voidsetSpreadId(java.lang.Integer spreadId)Sets the Id (i.e.voidsetTableColumn(int tableColumn)Sets the table column.voidsetTableIndex(int tableIndex)Sets the table index.voidsetTableRow(int tableRow)Sets the table row.voidsetTextmodel(int textmodel)Sets the textmodel.
-
-
-
Method Detail
-
getGroupId
java.lang.Integer getGroupId()
Gets the Id of the group, this element is part of.
Gets the Id of the group, this element is part of (if applicable). Group in this context is the CometGroup (rather than InDesign Group).
If the element is not part of any CometGroup, the Id is 0.- Returns:
- Id of the group or 0, if the element is not part of any group
-
setGroupId
void setGroupId(java.lang.Integer groupId)
Sets the Id of the group, this element is part of.
Sets the Id of the group, this element is part of.
SeegetGroupId()for further information.- Parameters:
groupId- Id of the group, this element is part of.
-
getPageId
java.lang.Integer getPageId()
Gets the Id (i.e. index) of the page, this element is located on.
Gets the Id (i.e. index) of the page, this element is located on.
- Returns:
- the Id (i.e. index) of the page, this element is located on
-
setPageId
void setPageId(java.lang.Integer pageId)
Sets the Id (i.e. index) of the page, this element is located on.
Sets the Id (i.e. page index) this element is located on
- Parameters:
pageId- the id (i.e. index) of the page, this element is located on
-
getSpreadId
java.lang.Integer getSpreadId()
Gets the Id (i.e. index) of the spread, this element is located on.
Gets the Id (i.e. index) of the spread, this element is located on.
- Returns:
- the Id (i.e. index) of the spread, this element is located on.
-
setSpreadId
void setSpreadId(java.lang.Integer spreadId)
Sets the Id (i.e. index) of the spread, this element is located on.
Sets the Id (i.e. index) of the spread, this element is located on.
- Parameters:
spreadId- the Id (i.e. index) of the spread, this element is located on.
-
getLayoutGroup
int getLayoutGroup()
Gets the layout group.- Returns:
- the layoutGroup
-
setLayoutGroup
void setLayoutGroup(int layoutGroup)
Sets the layout group.- Parameters:
layoutGroup- the layoutGroup to set
-
getInlinePosition
int getInlinePosition()
Gets the inline position.- Returns:
- the inlinePosition
-
setInlinePosition
void setInlinePosition(int inlinePosition)
Sets the inline position.- Parameters:
inlinePosition- the inlinePosition to set
-
getTableIndex
int getTableIndex()
Gets the table index.- Returns:
- the tableIndex
-
setTableIndex
void setTableIndex(int tableIndex)
Sets the table index.- Parameters:
tableIndex- the tableIndex to set
-
getTableRow
int getTableRow()
Gets the table row.- Returns:
- the tableRow
-
setTableRow
void setTableRow(int tableRow)
Sets the table row.- Parameters:
tableRow- the tableRow to set
-
getTableColumn
int getTableColumn()
Gets the table column.- Returns:
- the tableColumn
-
setTableColumn
void setTableColumn(int tableColumn)
Sets the table column.- Parameters:
tableColumn- the tableColumn to set
-
setTextmodel
void setTextmodel(int textmodel)
Sets the textmodel.- Parameters:
textmodel- the textmodel
-
getTextmodel
int getTextmodel()
Gets the textmodel.- Returns:
- the textmodel
-
-