org.apache.myfaces.custom.dojolayouts
Class DojoContentPane

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UIOutput
              org.apache.myfaces.custom.dojolayouts.AbstractDojoContentPane
                  org.apache.myfaces.custom.dojolayouts.DojoContentPane

All Implemented Interfaces:

javax.faces.component.StateHolder, javax.faces.component.ValueHolder, org.apache.myfaces.component.StyleAware, org.apache.myfaces.custom.dojo.DojoWidget

public class DojoContentPane
extends AbstractDojoContentPane

Field Summary

static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static java.lang.String	DEFAULT_RENDERER_TYPE

Constructor Summary

DojoContentPane()

Method Summary

java.lang.Boolean	getAdjustPaths() Path adjustment as defined by dojo
java.lang.Boolean	getCacheContent()
java.lang.Boolean	getExecuteScripts() If true scripts will be evaled after rendering
java.lang.Boolean	getExtractContent() Defined by dojo, see the examples
java.lang.String	getFamily()
java.lang.String	getHandler() Javascript function which should generate the content
java.lang.String	getHref() Remote href for iframe simulation
java.lang.String	getLayoutAlign() Layoutalignment usable in conjunction with a layout container
java.lang.Boolean	getParseContent() Defined by dojo see the examples
java.lang.Boolean	getPreload() Content Preloading
java.lang.Boolean	getRefreshOnShow() Description for the attribute
java.lang.String	getScriptScope() Scopecontainer for downloaded Scripts
java.lang.Integer	getSizeShare() Size share value describing the place the content pane wants from its parent
java.lang.String	getStyle() The CSS class for this element.
java.lang.String	getStyleClass() The CSS class for this element.
java.lang.String	getWidgetId() Optional enforced dojo widgetId
java.lang.String	getWidgetVar() optional widget var name, if this is not used only an autogenerated value is set
void	restoreState(javax.faces.context.FacesContext facesContext, java.lang.Object state)
java.lang.Object	saveState(javax.faces.context.FacesContext facesContext)
void	setAdjustPaths(java.lang.Boolean adjustPaths)
void	setCacheContent(java.lang.Boolean cacheContent)
void	setExecuteScripts(java.lang.Boolean executeScripts)
void	setExtractContent(java.lang.Boolean extractContent)
void	setHandler(java.lang.String handler)
void	setHref(java.lang.String href)
void	setLayoutAlign(java.lang.String layoutAlign)
void	setParseContent(java.lang.Boolean parseContent)
void	setPreload(java.lang.Boolean preload)
void	setRefreshOnShow(java.lang.Boolean refreshOnShow)
void	setScriptScope(java.lang.String scriptScope)
void	setSizeShare(java.lang.Integer sizeShare)
void	setStyle(java.lang.String style)
void	setStyleClass(java.lang.String styleClass)
void	setWidgetId(java.lang.String widgetId)
void	setWidgetVar(java.lang.String widgetVar)

Methods inherited from class javax.faces.component.UIOutput

getConverter, getLocalValue, getValue, setConverter, setValue

Methods inherited from class javax.faces.component.UIComponentBase

addFacesListener, broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY

See Also:

Constant Field Values

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

DEFAULT_RENDERER_TYPE

public static final java.lang.String DEFAULT_RENDERER_TYPE

See Also:

Constant Field Values

Constructor Detail

DojoContentPane

public DojoContentPane()

Method Detail

getFamily

public java.lang.String getFamily()

Overrides:

getFamily in class AbstractDojoContentPane

getAdjustPaths

public java.lang.Boolean getAdjustPaths()

Description copied from class: AbstractDojoContentPane

Path adjustment as defined by dojo

Specified by:

getAdjustPaths in class AbstractDojoContentPane

setAdjustPaths

public void setAdjustPaths(java.lang.Boolean adjustPaths)

getCacheContent

public java.lang.Boolean getCacheContent()

Specified by:

getCacheContent in class AbstractDojoContentPane

setCacheContent

public void setCacheContent(java.lang.Boolean cacheContent)

getExecuteScripts

public java.lang.Boolean getExecuteScripts()

Description copied from class: AbstractDojoContentPane

If true scripts will be evaled after rendering

Specified by:

getExecuteScripts in class AbstractDojoContentPane

setExecuteScripts

public void setExecuteScripts(java.lang.Boolean executeScripts)

getExtractContent

public java.lang.Boolean getExtractContent()

Description copied from class: AbstractDojoContentPane

Defined by dojo, see the examples

Specified by:

getExtractContent in class AbstractDojoContentPane

setExtractContent

public void setExtractContent(java.lang.Boolean extractContent)

getHandler

public java.lang.String getHandler()

Description copied from class: AbstractDojoContentPane

Javascript function which should generate the content

Specified by:

getHandler in class AbstractDojoContentPane

setHandler

public void setHandler(java.lang.String handler)

getHref

public java.lang.String getHref()

Description copied from class: AbstractDojoContentPane

Remote href for iframe simulation

Specified by:

getHref in class AbstractDojoContentPane

setHref

public void setHref(java.lang.String href)

getLayoutAlign

public java.lang.String getLayoutAlign()

Description copied from class: AbstractDojoContentPane

Layoutalignment usable in conjunction with a layout container

Specified by:

getLayoutAlign in class AbstractDojoContentPane

setLayoutAlign

public void setLayoutAlign(java.lang.String layoutAlign)

getParseContent

public java.lang.Boolean getParseContent()

Description copied from class: AbstractDojoContentPane

Defined by dojo see the examples

Specified by:

getParseContent in class AbstractDojoContentPane

setParseContent

public void setParseContent(java.lang.Boolean parseContent)

getPreload

public java.lang.Boolean getPreload()

Description copied from class: AbstractDojoContentPane

Content Preloading

Specified by:

getPreload in class AbstractDojoContentPane

setPreload

public void setPreload(java.lang.Boolean preload)

getRefreshOnShow

public java.lang.Boolean getRefreshOnShow()

Description copied from class: AbstractDojoContentPane

Description for the attribute

Specified by:

getRefreshOnShow in class AbstractDojoContentPane

setRefreshOnShow

public void setRefreshOnShow(java.lang.Boolean refreshOnShow)

getSizeShare

public java.lang.Integer getSizeShare()

Description copied from class: AbstractDojoContentPane

Size share value describing the place the content pane wants from its parent

Specified by:

getSizeShare in class AbstractDojoContentPane

setSizeShare

public void setSizeShare(java.lang.Integer sizeShare)

getStyle

public java.lang.String getStyle()

Description copied from class: AbstractDojoContentPane

The CSS class for this element. Corresponds to the HTML 'class' attribute.

Specified by:

getStyle in interface org.apache.myfaces.component.StyleAware

Specified by:

getStyle in class AbstractDojoContentPane

setStyle

public void setStyle(java.lang.String style)

getStyleClass

public java.lang.String getStyleClass()

Description copied from class: AbstractDojoContentPane

The CSS class for this element. Corresponds to the HTML 'class' attribute.

Specified by:

getStyleClass in interface org.apache.myfaces.component.StyleAware

Specified by:

getStyleClass in class AbstractDojoContentPane

setStyleClass

public void setStyleClass(java.lang.String styleClass)

getWidgetId

public java.lang.String getWidgetId()

Description copied from class: AbstractDojoContentPane

Optional enforced dojo widgetId

Specified by:

getWidgetId in interface org.apache.myfaces.custom.dojo.DojoWidget

Specified by:

getWidgetId in class AbstractDojoContentPane

setWidgetId

public void setWidgetId(java.lang.String widgetId)

getWidgetVar

public java.lang.String getWidgetVar()

Description copied from class: AbstractDojoContentPane

optional widget var name, if this is not used only an autogenerated value is set

Specified by:

getWidgetVar in interface org.apache.myfaces.custom.dojo.DojoWidget

Specified by:

getWidgetVar in class AbstractDojoContentPane

setWidgetVar

public void setWidgetVar(java.lang.String widgetVar)

getScriptScope

public java.lang.String getScriptScope()

Description copied from class: AbstractDojoContentPane

Scopecontainer for downloaded Scripts

Specified by:

getScriptScope in class AbstractDojoContentPane

setScriptScope

public void setScriptScope(java.lang.String scriptScope)

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext facesContext)

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class javax.faces.component.UIOutput

restoreState

public void restoreState(javax.faces.context.FacesContext facesContext,
                         java.lang.Object state)

Specified by:

restoreState in interface javax.faces.component.StateHolder

Overrides:

restoreState in class javax.faces.component.UIOutput