Package com.priint.pubserver.metadata.element

Interface Element

  • All Superinterfaces:
    DocumentElement, java.io.Serializable
    All Known Implementing Classes:
    ElementImpl
    public interface Element
extends DocumentElement

    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.

    • Method Detail

      • getExt

        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

      • setExt

        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

      • getRecord

        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

      • setRecord

        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

      • getParents

        Parents getParents()

        Gets parents of this element.

        Gets parents of this element. See the Parents interface for further information.

        Returns:
        parents of this element

      • setParents

        void setParents​(Parents parents)

        Sets parents of this element.

        Sets parents this element. See getParents() for further information.

        Parameters:
        parents - of this element

      • getIdGroupId

        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

      • setIdGroupId

        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

      • getType

        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

      • setType

        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

      • getInsetLeft

        double getInsetLeft()

        Gets the left inset of this element.

        Gets the left inset (aka padding) of this element.

        Returns:
        left inset of this element

      • setInsetLeft

        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

      • getInsetRight

        double getInsetRight()

        Gets the right inset of this element.

        Gets the right inset (aka padding) of this element.

        Returns:
        right inset of this element

      • setInsetRight

        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

      • getInsetTop

        double getInsetTop()

        Gets the top inset of this element.

        Gets the top inset (aka padding) of this element.

        Returns:
        top inset of this element

      • setInsetTop

        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

      • getInsetBottom

        double getInsetBottom()

        Gets the bottom inset of this element.

        Gets the bottom inset (aka padding) of this element.

        Returns:
        bottom inset of this element

      • setInsetBottom

        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

      • getColumns

        int getColumns()

        Gets the number of columns of this element.

        Gets the number of text columns of this element.

        Returns:
        number of columns

      • setColumns

        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

      • getGutter

        double getGutter()

        Gets the gutter of this element.

        Gets the gutter, i.e. padding between columns, of this element.

        Returns:
        gutter of this element

      • setGutter

        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

      • getOrigin

        Origin getOrigin()

        Gets origin of this element.

        Gets origin of this element, i.e masterpage or regular page.

        Returns:
        origin of this documnet

      • setOrigin

        void setOrigin​(Origin origin)

        Sets the origin of this element<.

        Sets the origin of this element.

        Parameters:
        origin - origin of this element.

      • getBbox

        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.

      • setBbox

        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.

      • getArea

        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.

      • setArea

        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.

      • getTextcontent

        TextContent getTextcontent()
        Gets the textcontent.
        Returns:
        the textcontent

      • setTextcontent

        void setTextcontent​(TextContent textcontent)
        Sets the textcontent.
        Parameters:
        textcontent - the new textcontent

      • getIdlabels

        java.util.List<IDLabel> getIdlabels()
        Gets the idlabels.
        Returns:
        the idlabels

      • setIdlabels

        void setIdlabels​(java.util.List<IDLabel> idlabels)
        Sets the idlabels.
        Parameters:
        idlabels - the new idlabels

      • getIdtag

        IDTag getIdtag()
        Gets the idtag.
        Returns:
        the idtag

      • setIdtag

        void setIdtag​(IDTag idtag)
        Sets the idtag.
        Parameters:
        idtag - the new idtag

      • getChainPrevious

        int getChainPrevious()

        Gets the previous element in the chain

        .
        Returns:
        ID of previous element in chain, 0, if no previous element exists

      • setChainPrevious

        void setChainPrevious​(int chainPrevious)

        Sets the previous element in chain.

        Parameters:
        chainPrevious - previous element in chain, 0, if no previous element exists

      • getChainNext

        int getChainNext()

        Gets the next element in the chain

        .
        Returns:
        ID of next element in chain, 0, if no next element exists

      • setChainNext

        void setChainNext​(int chainNext)

        Sets the next element in chain.

        Parameters:
        chainNext - next element in chain, 0, if no next element exists

      • getChainHasOverset

        boolean getChainHasOverset()

        Gets, whether there is overset in any of the elements in chain.

        Returns:
        true, if there is overset, false otherwise

      • setChainHasOverset

        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.

      • setOriginInMaster

        void setOriginInMaster​(java.lang.String originInMaster)
        Sets the origin in master.
        Parameters:
        originInMaster - the originInMaster property to set

      • getOriginInMaster

        java.lang.String getOriginInMaster()
        Gets the origin in master.
        Returns:
        originInMaster

      • setOriginUid

        void setOriginUid​(int originUid)
        Sets the origin uid.
        Parameters:
        originUid - the originUid property to set

      • getOriginUid

        int getOriginUid()
        Gets the origin uid.
        Returns:
        originUid

      • setLocked

        void setLocked​(int locked)
        Sets the locked.
        Parameters:
        locked - the locked property to set

      • getLocked

        int getLocked()
        Gets the locked.
        Returns:
        locked

      • setVisible

        void setVisible​(boolean visible)
        Sets the visible.
        Parameters:
        visible - the visible property to set

      • isVisible

        boolean isVisible()
        Checks if is visible.
        Returns:
        visible

      • setTextmodel

        void setTextmodel​(int textmodel)
        Sets the textmodel.
        Parameters:
        textmodel - the textmodel property to set

      • getTextmodel

        int getTextmodel()
        Gets the textmodel.
        Returns:
        textmodel

      • setVerticalJustification

        void setVerticalJustification​(int verticalJustification)
        Sets the vertical justification.
        Parameters:
        verticalJustification - the verticalJustification property to set

      • getVerticalJustification

        int getVerticalJustification()
        Gets the vertical justification.
        Returns:
        verticalJustification

      • setSequence

        void setSequence​(int sequence)
        Sets the sequence.
        Parameters:
        sequence - the sequence property to set

      • getSequence

        int getSequence()
        Gets the sequence.
        Returns:
        sequence

      • setChainParentId

        void setChainParentId​(int chainParentId)
        Sets the chain parent id.
        Parameters:
        chainParentId - the chainParentId property to set

      • getChainParentId

        int getChainParentId()
        Gets the chain parent id.
        Returns:
        chainParentId

      • setInteractive

        void setInteractive​(int interactive)
        Sets the interactive.
        Parameters:
        interactive - the interactive property to set

      • getInteractive

        int getInteractive()
        Gets the interactive.
        Returns:
        interactive

      • setUitype

        void setUitype​(java.lang.String uitype)
        Sets the uitype.
        Parameters:
        uitype - the uitype property to set

      • getUitype

        java.lang.String getUitype()
        Gets the uitype.
        Returns:
        uitype

      • setObjectstyle

        void setObjectstyle​(int objectstyle)
        Sets the objectstyle.
        Parameters:
        objectstyle - the objectstyle property to set

      • getObjectstyle

        int getObjectstyle()
        Gets the objectstyle.
        Returns:
        objectstyle

      • setImagecontent

        void setImagecontent​(ImageContent imagecontent)
        Sets the imagecontent.
        Parameters:
        imagecontent - the imagecontent to set

      • getImagecontent

        ImageContent getImagecontent()
        Gets the imagecontent.
        Returns:
        the imagecontent

      • setProperties

        void setProperties​(ElementProperties properties)
        Sets the properties.
        Parameters:
        properties - the properties to set

      • getProperties

        ElementProperties getProperties()
        Gets the properties.
        Returns:
        the properties

      • setFittingOptions

        void setFittingOptions​(FittingOptions fittingOptions)
        Sets the fitting options.
        Parameters:
        fittingOptions - the new fitting options

      • getFittingOptions

        FittingOptions getFittingOptions()
        Gets the fitting options.
        Returns:
        the fitting options