Package nl.gx.webmanager.cms.presentation

Interface Presentation

  • All Superinterfaces:
    Wrapper
    All Known Subinterfaces:
    PresentationVariant
    public interface Presentation
extends Wrapper
    Presentation objects represent the presentation descriptors and jsps. A presentation object can render objects. It is also accessible from the jsps. Style information from webmanager such as images, colors, buttons & fonts is also made available.

    • Method Detail

      • render

        void render​(javax.servlet.http.HttpServletRequest req,
            javax.servlet.http.HttpServletResponse res,
            Object baseObject,
            boolean ignoreServerSideIncludeLocation)
     throws IOException,
            javax.servlet.ServletException
        Presentation objects can render themselves to the response output stream.
        Parameters:
        req -
        res -
        baseObject -
        ignoreServerSideIncludeLocation -
        Throws:
        IOException
        javax.servlet.ServletException

      • getLocation

        String getLocation()
        Return location of the object.
        Returns:
        location of the object.

      • getLocation

        default String getLocation​(boolean ignoreSsi)
        Return location of the object.
        Parameters:
        ignoreSsi - flag to ignore ssi locations as viable return value.
        Returns:
        location of the object.

      • getScopes

        String[] getScopes()
        Return array of scope names of this presentation object.
        Returns:
        array of scope names of this presentation object.

      • isAvailable

        boolean isAvailable()
        Returns a boolean indicating if the presentation is available. If the setting is unknown the result will be false.
        Returns:
        the default-presentation-is-available setting true or false.

      • getTemplateName

        String getTemplateName()
        Return template name.
        Returns:
        template name.

      • getImage

        Image getImage​(String label,
               Page page,
               boolean useTargetPageStyle)
        Get image for a label (specified in the descriptor) & page.
        Parameters:
        label - image label
        page - page where the image is displayed
        Returns:
        a Image object.

      • getImageByProperty

        Image getImageByProperty​(int property)
        Get the image of a particular style property.
        Parameters:
        property - id of the property object
        Returns:
        a Image object

      • getPresentationVariants

        List<PresentationVariant> getPresentationVariants()
        Returns the presentation variants available for this presentation. Returns an empty list if no variants are available.
        Returns:
        List of presentation variants available for this presentation, empty list of none are available

      • getPresentationVariant

        PresentationVariant getPresentationVariant​(String name)
        Returns the presentation variant for this presentation with the specified name, or null if no such presentation variant exists.
        Parameters:
        name - Name of the presentation variant to retrieve
        Returns:
        the presentation variant for this presentation with the specified name

      • createPresentationVariant

        PresentationVariant createPresentationVariant​(String name)
        Creates a presentation variant for this presentation and returns it. Use PresentationVariant.addPropertyValue to set any property values for this variant. If a presentation variant with the specified name already exists, this existing variant is returned.
        Parameters:
        name - The name of the presentation variant to create.
        Returns:
        The created presentation variant

      • getPropertyDataType

        String getPropertyDataType​(String propertyName)
        Return type of the property.
        Parameters:
        propertyName - name of the property
        Returns:
        type of the property.

      • getPropertyValue

        String getPropertyValue​(String propertyName)
        Get value for a property.
        Parameters:
        propertyName - name of the property
        Returns:
        value.

      • getPropertyDefinitions

        List<PresentationVariantPropertyDefinition> getPropertyDefinitions()
        Returns the available property definitions for this presentation, as described in the descriptor of this presentation.
        Returns:
        the available property definitions for this presentation

      • getIdentifier

        String getIdentifier()
        Return identifier of this presentation object.
        Returns:
        identifier of this presentation object.

      • getDisplayName

        String getDisplayName()
        Return the human readable name of this presentation object.
        Returns:
        display name of this presentation object.

      • getRanking

        Integer getRanking()
        Return the ranking of this presentation object, which defines an optional ordering of presentations. A lower ranking generally means a higher priority and therefore before other presentations when sorting.
        Returns:
        the possibly negative ranking of this presentation object, or null if not set

      • getFrames

        PresentationFrame[] getFrames()
        Return array of PresentationRegion.
        Returns:
        array of PresentationRegion.

      • getWebsite

        Website getWebsite()
        Return website of this presentation object.
        Returns:
        website of this presentation object.

      • getContentType

        String getContentType()
        Return the contenttype value set in de the descriptor of the presentation
        Returns:
        string with contenttype value (f.e. application/json)