nl.gx.webmanager.cms.presentation
Interface Presentation

All Superinterfaces:

Wrapper

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 Summary

Button	getButton(java.lang.String label, Page page, boolean useTargetPageStyle) Get button for a label (specified in the descriptor) & page.
Button	getButtonByProperty(int property) Get the button of a particular style property.
Color	getColor(java.lang.String label, Page page, boolean useTargetPageStyle) Get color for a label (specified in the descriptor) & page.
Color	getColorByProperty(int property) Get the color of a particular style property.
java.lang.String	getDisplayName() Return the human readable of this presentation object.
Font	getFont(java.lang.String label, Page page, boolean useTargetPageStyle) Get font for a label (specified in the descriptor) & page.
Font	getFontByProperty(int property) Get the font of a particular style property.
PresentationFrame[]	getFrames() Return array of PresentationRegion.
java.lang.String	getIdentifier() Return identifier of this presentation object.
Image	getImage(java.lang.String label, Page page, boolean useTargetPageStyle) Get image for a label (specified in the descriptor) & page.
Image	getImageByProperty(int property) Get the image of a particular style property.
java.lang.String	getLocation() Return location of the object.
java.lang.String	getPropertyDataType(java.lang.String propertyName) Return type of the property.
java.lang.String	getPropertyValue(java.lang.String propertyName) Get value for a property.
java.lang.String[]	getScopes() Return array of scope names of this presentation object.
java.lang.String	getTemplateName() Return template name.
Website	getWebsite() Return website of this presentation object.
boolean	isAvailable() Returns a boolean indicating if the presentation is available.
void	render(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, java.lang.Object baseObject, boolean ignoreServerSideIncludeLocation) Presentation objects can render themselves to the response output stream.

Methods inherited from interface nl.gx.webmanager.wrapper.Wrapper

getId, getUUID, setId, setUUID

Method Detail

render

void render(javax.servlet.http.HttpServletRequest req,
            javax.servlet.http.HttpServletResponse res,
            java.lang.Object baseObject,
            boolean ignoreServerSideIncludeLocation)
            throws java.io.IOException,
                   javax.servlet.ServletException

Presentation objects can render themselves to the response output stream.

Parameters:

req -

res -

baseObject -

ignoreServerSideIncludeLocation -

Throws:

java.io.IOException

javax.servlet.ServletException

getLocation

java.lang.String getLocation()

Return location of the object.

Returns:

location of the object.

getScopes

java.lang.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

java.lang.String getTemplateName()

Return template name.

Returns:

template name.

getColor

Color getColor(java.lang.String label,
               Page page,
               boolean useTargetPageStyle)

Get color for a label (specified in the descriptor) & page.

Parameters:

label - color label

page - page where the color is displayed

Returns:

a Color object.

getColorByProperty

Color getColorByProperty(int property)

Get the color of a particular style property.

Parameters:

property - id of the property object

Returns:

a Color object.

getFont

Font getFont(java.lang.String label,
             Page page,
             boolean useTargetPageStyle)

Get font for a label (specified in the descriptor) & page.

Parameters:

label - font label

page - page where the font is displayed

Returns:

a Font object.

getFontByProperty

Font getFontByProperty(int property)

Get the font of a particular style property.

Parameters:

property - id of the property object

Returns:

a Font object

getImage

Image getImage(java.lang.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

getButton

Button getButton(java.lang.String label,
                 Page page,
                 boolean useTargetPageStyle)

Get button for a label (specified in the descriptor) & page.

Parameters:

label - button label

page - page where the image is displayed

Returns:

a Button object.

getButtonByProperty

Button getButtonByProperty(int property)

Get the button of a particular style property.

Parameters:

property - id of the property object

Returns:

a Button object

getPropertyDataType

java.lang.String getPropertyDataType(java.lang.String propertyName)

Return type of the property.

Parameters:

propertyName - name of the property

Returns:

type of the property.

getPropertyValue

java.lang.String getPropertyValue(java.lang.String propertyName)

Get value for a property.

Parameters:

propertyName - name of the property

Returns:

value.

getIdentifier

java.lang.String getIdentifier()

Return identifier of this presentation object.

Returns:

identifier of this presentation object.

getDisplayName

java.lang.String getDisplayName()

Return the human readable of this presentation object.

Returns:

display name of this presentation object.

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.