nl.gx.webmanager.cms.core
Interface PresentationContext

public interface PresentationContext

Representation of the PresentationContext. The presentation context provides the context in which webmanager jsps are executed and provides access to lots of information.

Field Summary

static java.lang.String

PRESENTATION_CONTEXT_KEY The default location for the presentation context in the http request.

Method Summary

java.lang.Object	getBaseObject() Return object at the top of the stack.
Page	getBlock() Return Last rendered block.
java.lang.String	getChannel() Return the channel for this presentationcontext.
Element	getElement() Return Element of this PresentationContext.
ElementHolder	getElementHolder() Return the last elementHolder from the stack.
Form	getForm() Return Form of this PresentationContext.
java.lang.Object	getInstance(int id, java.lang.Class targetClass) Return a wrapper of class targetClass for a particular object.
Mailing	getMailing() Return Mailing of this PresentationContext.
MediaItem	getMediaItem() Return MediaItem of this PresentationContext.
MediaItemVersion	getMediaItemVersion() Return MediaItem metadata of this PresentationContext.
Page	getPage() Return Page of this PresentationContext.
PageModel	getPageModel() Return PageModel of this PresentationContext.
PagePart	getPagePart() Return PagePart of this PresentationContext.
PageVersion	getPageVersion() Return PageVersion of this PresentationContext.
Form	getParentForm() Return ParentForm of this PresentationContext.
Presentable	getPresentable() Return Presentable of this PresentationContext.
Presentation	getPresentation() Return Presentation of this PresentationContext.
java.lang.String	getPresentationQs() Return History of objects and thier presentation, separated by _ and #.
ResourceEntity	getResourceEntity() Return ResourceEntity of this PresentationContext.
ResourceInstance	getResourceInstance() Return ResourceInstance of this PresentationContext.
Website	getWebsite() Return Website of this PresentationContext.
boolean	isAuthorized() Return true if the user may view the page in the preview mode.
boolean	isDumpRequest() Return true if the request is from the WebManager dumper.
boolean	isInlineRequest() Return true if the user is using the webmanager inline editing mode.
boolean	isPreviewRequest() Return true if the user is using the webmanager preview mode.
boolean	isSecureRequest() Return true if the request is from https.
boolean	isTextVersionRequest() Return true if a textversion is requested.
boolean	isWebsiteRequest() Return true if the request is a website request (starting with /web).
void	pop() Pop the top object and presentation.
void	push(java.lang.Object object, Presentation presentation) Add an object and a presentation to the stack.
void	restorePageVersion() Undoes the last setPageVersion() call.
void	setMailing(Mailing mailing) Return set the mailing.
void	setMediaItem(MediaItem mediaItem) Return set the mediaItem.
void	setMediaItemVersion(MediaItemVersion mediaItem) Return set the mediaItem.
void	setPageModel(PageModel pageModel) Sets the pageModel for this PresentationContext.
void	setPageVersion(PageVersion pageVersion, Presentation presentation) Return set the pageVersion and page and adds the presentation to the stack.
void	setResourceReference(ResourceEntity resourceEntity, ResourceInstance resourceInstance) Return set the resourceEntity and resourceInstance.

Field Detail

PRESENTATION_CONTEXT_KEY

static final java.lang.String PRESENTATION_CONTEXT_KEY

The default location for the presentation context in the http request.

See Also:

Constant Field Values

Method Detail

push

void push(java.lang.Object object,
          Presentation presentation)

Add an object and a presentation to the stack.

Parameters:

object -

presentation -

pop

void pop()

Pop the top object and presentation.

getBaseObject

java.lang.Object getBaseObject()

Return object at the top of the stack.

Returns:

object at the top of the stack.

getInstance

java.lang.Object getInstance(int id,
                             java.lang.Class targetClass)

Return a wrapper of class targetClass for a particular object.

Parameters:

id - object id

targetClass - the wrapper class that should be instantiated.

Returns:

the wrapper object.

getPageVersion

PageVersion getPageVersion()

Return PageVersion of this PresentationContext.

Returns:

PageVersion of this PresentationContext.

getPageModel

PageModel getPageModel()

Return PageModel of this PresentationContext.

Returns:

PageModel of this PresentationContext.

getPage

Page getPage()

Return Page of this PresentationContext.

Returns:

Page of this PresentationContext.

getPagePart

PagePart getPagePart()

Return PagePart of this PresentationContext.

Returns:

PagePart of this PresentationContext.

getPresentation

Presentation getPresentation()

Return Presentation of this PresentationContext.

Returns:

Presentation of this PresentationContext.

getPresentable

Presentable getPresentable()

Return Presentable of this PresentationContext.

Returns:

Presentable of this PresentationContext.

getElementHolder

ElementHolder getElementHolder()

Return the last elementHolder from the stack.

Returns:

the last elementHolder from the stack.

getElement

Element getElement()

Return Element of this PresentationContext.

Returns:

Element of this PresentationContext.

getMediaItem

MediaItem getMediaItem()

Return MediaItem of this PresentationContext.

Returns:

MediaItem of this PresentationContext.

getMediaItemVersion

MediaItemVersion getMediaItemVersion()

Return MediaItem metadata of this PresentationContext.

Returns:

MediaItem metadata of this PresentationContext.

getWebsite

Website getWebsite()

Return Website of this PresentationContext.

Returns:

Website of this PresentationContext.

getMailing

Mailing getMailing()

Return Mailing of this PresentationContext.

Returns:

Mailing of this PresentationContext.

getResourceInstance

ResourceInstance getResourceInstance()

Return ResourceInstance of this PresentationContext.

Returns:

ResourceInstance of this PresentationContext.

getResourceEntity

ResourceEntity getResourceEntity()

Return ResourceEntity of this PresentationContext.

Returns:

ResourceEntity of this PresentationContext.

getForm

Form getForm()

Return Form of this PresentationContext.

Returns:

Form of this PresentationContext.

getBlock

Page getBlock()

Return Last rendered block.

Returns:

Last rendered block.

getParentForm

Form getParentForm()

Return ParentForm of this PresentationContext.

Returns:

ParentForm of this PresentationContext.

getPresentationQs

java.lang.String getPresentationQs()

Return History of objects and thier presentation, separated by _ and #.

Returns:

History of objects and thier presentation.

isDumpRequest

boolean isDumpRequest()

Return true if the request is from the WebManager dumper.

Returns:

true if the request is from the WebManager dumper.

isSecureRequest

boolean isSecureRequest()

Return true if the request is from https.

Returns:

true if the request is from https.

isPreviewRequest

boolean isPreviewRequest()

Return true if the user is using the webmanager preview mode.

Returns:

true if the user is using the webmanager preview mode.

isInlineRequest

boolean isInlineRequest()

Return true if the user is using the webmanager inline editing mode.

Returns:

true if the user is using the webmanager inline editing mode.

getChannel

java.lang.String getChannel()

Return the channel for this presentationcontext.

Returns:

the channel for this presentationcontext.

isWebsiteRequest

boolean isWebsiteRequest()

Return true if the request is a website request (starting with /web).

Returns:

true if this is a website request

isTextVersionRequest

boolean isTextVersionRequest()

Return true if a textversion is requested.

Returns:

true if a textversion is requested.

isAuthorized

boolean isAuthorized()

Return true if the user may view the page in the preview mode.

Returns:

true if the user may view the page in the preview mode

setPageVersion

void setPageVersion(PageVersion pageVersion,
                    Presentation presentation)

Return set the pageVersion and page and adds the presentation to the stack.

restorePageVersion

void restorePageVersion()

Undoes the last setPageVersion() call. Restoring the previous page version.

setPageModel

void setPageModel(PageModel pageModel)

Sets the pageModel for this PresentationContext.

setMediaItem

void setMediaItem(MediaItem mediaItem)

Return set the mediaItem.

setMediaItemVersion

void setMediaItemVersion(MediaItemVersion mediaItem)

Return set the mediaItem.

setMailing

void setMailing(Mailing mailing)

Return set the mailing.

setResourceReference

void setResourceReference(ResourceEntity resourceEntity,
                          ResourceInstance resourceInstance)

Return set the resourceEntity and resourceInstance.