Interface Element

    • Method Detail

      • getId

        @ReferField(stored=false)
        int getId()
        Description copied from interface: Wrapper
        Returns the ID of the wrapped object.
        Specified by:
        getId in interface Wrapper
        Returns:
        the ID of the wrapped object.
      • getPersonalizationItems

        @Deprecated
        PersonalizationItem[] getPersonalizationItems()
        Deprecated.
        Returns the personalizations assigned to this element or an empty array if none are assigned.
        Returns:
        the personalizations assigned to this element or an empty array if none are assigned
      • setPersonalizationItems

        @Deprecated
        void setPersonalizationItems​(PersonalizationItem[] personalizations)
        Deprecated.
        use #setPersonalizationAttributes() instead
        Sets the personalizations which are assigned to this element.
        Parameters:
        personalizations - the personalizations which are assigned to this element. In case this is null or an empty array all assigned personalization are removed
      • setPersonalizationOperator

        @Deprecated
        void setPersonalizationOperator​(PersonalizationModel.Operator operator)
        Deprecated.
        use #setPersonalizationAttributes() instead
        Set the personalization operator on an element.
        Parameters:
        operator - the personalization operator to assign.
      • getPersonalizationAttributes

        PersonalizationAttributes getPersonalizationAttributes()
        Retrieves the personalization attributes on an element.
        Returns:
        the personalization attributes assigned to this element.
      • setPersonalizationAttributes

        void setPersonalizationAttributes​(PersonalizationAttributes attributes)
        Sets the personalization attributes on an element.
        Parameters:
        attributes - the personalization attributes to assign.
      • getPageVersion

        PageVersion getPageVersion()
        Returns the page version this element is on.
        Returns:
        the page version this element is on.
      • getMediaItemVersion

        MediaItemVersion getMediaItemVersion()
        Returns the media item version this element is on. Returns null if the element is not contained by a media item version.
        Returns:
        media item version this element is on
      • getPageModel

        @Deprecated
        nl.gx.webmanager.cms.pagemodel.PageModel getPageModel()
        Deprecated.
        Page Models are phased out in XC.
        Returns the page model this element is on. Returns null if the element is not contained by a page model.
        Returns:
        page model this element is on
      • getPageModelElement

        @Deprecated
        nl.gx.webmanager.cms.pagemodel.PageModelElement getPageModelElement()
        Deprecated.
        Page Models are phased out in XC.
        If the element is a page model element returns the page model element representation of the element, else returns null.
        Returns:
        The page model element representation of the element.
      • getElementHolder

        ElementHolder getElementHolder()
        Returns the ElementHolder that contains this Element.
        Returns:
        the ElementHolder that contains this Element.
      • getWebsite

        Website getWebsite()
        Returns the web site this element is on.
        Returns:
        the web site this element is on.
      • getEditElementHeader

        String getEditElementHeader()
        Returns the header text of an element.
        Returns:
        header text
      • setEditElementHeader

        void setEditElementHeader​(String header)
        Sets the header text of an element.
        Parameters:
        header - header text to set
      • getHeader

        String getHeader()
        Returns the header of the element to display in the title bar of the element
        Returns:
        header of the element
      • setHeader

        void setHeader​(String header)
        Sets the header of the element to display in the title bar of the element
        Parameters:
        header - header of the element to set
      • getIcon

        String getIcon()
        Returns the name of the icon on disk.
        Returns:
        the name of the icon on disk
      • setIcon

        void setIcon​(String icon)
        Sets the name of the icon on disk.
        Parameters:
        icon - the name of the icon on disk to set
      • isAuthorized

        boolean isAuthorized()
        Returns true if the current user has permission to edit the element.
        Returns:
        true if the current user has permission to edit the element
      • setAuthorized

        void setAuthorized​(boolean authorized)
        Sets if the current user has permission to edit the element.
        Parameters:
        authorized - indicating if the current user has permission to edit the element
      • cleanup

        @Deprecated
        void cleanup()
        Deprecated.
        Lifecycle method which is called just before the element is deleted.
      • setDefaultPresentation

        void setDefaultPresentation()
        Sets a default presentation for the element.
      • getTypeIdentifier

        String getTypeIdentifier()
        Returns the identifier for the element type (eg. ImageElement). This type is configured in the activator.
        Returns:
        identifier of the element type
      • getLastModifiedDate

        Date getLastModifiedDate()
        Returns the last modified date of the element.
        Returns:
        last modified date.
      • setLastModifiedDate

        void setLastModifiedDate​(Date date)
        Sets the last modified date of the element.
        Parameters:
        date - last modified date. If null the current date is used.
      • getIdentity

        String getIdentity()
        Returns a String used as identity of this element. Multiple elements can have the same identity if they represent the same element, which can happen when a copy of an element is created when editing an element through the user interface. Returns null if no identity has been set.
        Returns:
        a String used as identity of this element. Multiple elements can have the same identity if they represent the same element, which can happen when a copy of an element is created when editing an element through the user interface
      • setIdentity

        void setIdentity​(String identity)
        Sets the given identity for this element. Multiple elements can have the same identity if they represent the same element, which can happen when a copy of an element is created when editing an element through the user interface.
        Parameters:
        identity - String to use as identity for this element
      • setTitle

        void setTitle​(String title)
        Sets the title of an element.
        Parameters:
        title - title to set