com.ibm.mashups.enabler.content
Interface StaticContentPage

All Superinterfaces:

ContentNode, ContentPage, com.ibm.mashups.enabler.DirtyFlagProvider, Identifiable, MetaData, ModifiableMetaData, com.ibm.mashups.enabler.Transformable

public StaticContentPage
extends ContentPage, ModifiableMetaData

This interface exposes the contents of the static template for a content provider. The template defines containers, also referred to as dynamic spots, which may be populated with widgets. Use this model to identify containers, or to modify the contents of the template. Use the layout model to populate the containers with controls, respectively widgets.

Since:

2.4

See Also:

LayoutModel, LayoutContainer, LayoutControl

Method Summary

Deferred	getStaticMarkup() Returns the markup of this static content provider.
void	setStaticMarkup(String markup) Sets the markup of this static content provider.
Boolean	confirmSetStaticMarkup(String markup) Confirms whether setStaticMarkup() can be performed.
void	refreshStaticMarkup() Refreshes the static content when the underlying model is committed.
Boolean	confirmRefreshStaticMarkup() Confirms whether refreshStaticMarkup() can be performed.
String	getStaticContentURL() Returns the URL of the static content.
void	setStaticContentURL(String url) Sets the url to the static content.
Boolean	confirmSetStaticContentURL(String url) Confirms whether setStaticContentURL() can be performed.

Methods inherited from interface com.ibm.mashups.enabler.Identifiable

getID

Methods inherited from interface com.ibm.mashups.enabler.ModifiableMetaData

setMetaData, confirmSetMetaData, removeMetaData, confirmRemoveMetaData

Methods inherited from interface com.ibm.mashups.enabler.MetaData

getMetaDataNames, getMetaData

Methods inherited from interface com.ibm.mashups.enabler.ModifiableMetaData

setMetaData, confirmSetMetaData, removeMetaData, confirmRemoveMetaData

Methods inherited from interface com.ibm.mashups.enabler.MetaData

getMetaDataNames, getMetaData

Method Detail

getStaticMarkup

Deferred getStaticMarkup()

Returns the markup of this static content provider.

Returns:

A deferred object used to start this operation, never null. The return value when executed through the deferred object is the static markup.

setStaticMarkup

void setStaticMarkup(String markup)

Sets the markup of this static content provider.

Parameters:

markup - the markup, must not be null

confirmSetStaticMarkup

Boolean confirmSetStaticMarkup(String markup)

Confirms whether setStaticMarkup() can be performed.

Parameters:

markup - see parameter description of method to confirm

Returns:

true if it can be performed, false otherwise

refreshStaticMarkup

void refreshStaticMarkup()

Refreshes the static content when the underlying model is committed.

confirmRefreshStaticMarkup

Boolean confirmRefreshStaticMarkup()

Confirms whether refreshStaticMarkup() can be performed.

Returns:

true if it can be performed, false otherwise

getStaticContentURL

String getStaticContentURL()

Returns the URL of the static content.

Returns:

absolute url to the static content

setStaticContentURL

void setStaticContentURL(String url)

Sets the url to the static content.

Parameters:

url - the absolute url to the static content

confirmSetStaticContentURL

Boolean confirmSetStaticContentURL(String url)

Confirms whether setStaticContentURL() can be performed.

Parameters:

url - see parameter description of method to confirm

Returns:

true if it can be performed, false otherwise