org.apache.myfaces.custom.dojolayouts
Class AbstractDojoContentPane

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by javax.faces.component.UIOutput
              extended by org.apache.myfaces.custom.dojolayouts.AbstractDojoContentPane
All Implemented Interfaces:
javax.faces.component.StateHolder, javax.faces.component.ValueHolder, org.apache.myfaces.component.StyleAware, org.apache.myfaces.custom.dojo.DojoWidget

public abstract class AbstractDojoContentPane
extends javax.faces.component.UIOutput
implements org.apache.myfaces.custom.dojo.DojoWidget, org.apache.myfaces.component.StyleAware

Base content pane for the dojo layouts jsfed dojo content pane

Author:
werpu
See Also:
for further references to this control and its parameters

Field Summary
static java.lang.String COMPONENT_FAMILY
           
static java.lang.String COMPONENT_TYPE
           
static java.lang.String DEFAULT_RENDERER_TYPE
           
 
Fields inherited from class javax.faces.component.UIComponent
bindings
 
Constructor Summary
AbstractDojoContentPane()
           
 
Method Summary
abstract  java.lang.Boolean getAdjustPaths()
          Path adjustment as defined by dojo
abstract  java.lang.Boolean getCacheContent()
           
abstract  java.lang.Boolean getExecuteScripts()
          If true scripts will be evaled after rendering
abstract  java.lang.Boolean getExtractContent()
          Defined by dojo, see the examples
 java.lang.String getFamily()
           
abstract  java.lang.String getHandler()
          Javascript function which should generate the content
abstract  java.lang.String getHref()
          Remote href for iframe simulation
abstract  java.lang.String getLayoutAlign()
          Layoutalignment usable in conjunction with a layout container
abstract  java.lang.Boolean getParseContent()
          Defined by dojo see the examples
abstract  java.lang.Boolean getPreload()
          Content Preloading
abstract  java.lang.Boolean getRefreshOnShow()
          Description for the attribute
abstract  java.lang.String getScriptScope()
          Scopecontainer for downloaded Scripts
abstract  java.lang.Integer getSizeShare()
          Size share value describing the place the content pane wants from its parent
abstract  java.lang.String getStyle()
          The CSS class for this element.
abstract  java.lang.String getStyleClass()
          The CSS class for this element.
abstract  java.lang.String getWidgetId()
          Optional enforced dojo widgetId
abstract  java.lang.String getWidgetVar()
          optional widget var name, if this is not used only an autogenerated value is set
 
Methods inherited from class javax.faces.component.UIOutput
getConverter, getLocalValue, getValue, restoreState, saveState, setConverter, setValue
 
Methods inherited from class javax.faces.component.UIComponentBase
addFacesListener, broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding
 
Methods inherited from class javax.faces.component.UIComponent
encodeAll, getContainerClientId, getValueExpression, setValueExpression
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.apache.myfaces.custom.dojo.DojoWidget
setWidgetId, setWidgetVar
 

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

AbstractDojoContentPane

public AbstractDojoContentPane()
Method Detail

getAdjustPaths

public abstract java.lang.Boolean getAdjustPaths()
Path adjustment as defined by dojo


getCacheContent

public abstract java.lang.Boolean getCacheContent()

getExecuteScripts

public abstract java.lang.Boolean getExecuteScripts()
If true scripts will be evaled after rendering


getExtractContent

public abstract java.lang.Boolean getExtractContent()
Defined by dojo, see the examples


getFamily

public java.lang.String getFamily()
Overrides:
getFamily in class javax.faces.component.UIOutput

getHandler

public abstract java.lang.String getHandler()
Javascript function which should generate the content


getHref

public abstract java.lang.String getHref()
Remote href for iframe simulation


getLayoutAlign

public abstract java.lang.String getLayoutAlign()
Layoutalignment usable in conjunction with a layout container


getParseContent

public abstract java.lang.Boolean getParseContent()
Defined by dojo see the examples


getPreload

public abstract java.lang.Boolean getPreload()
Content Preloading


getRefreshOnShow

public abstract java.lang.Boolean getRefreshOnShow()
Description for the attribute


getSizeShare

public abstract java.lang.Integer getSizeShare()
Size share value describing the place the content pane wants from its parent


getStyle

public abstract java.lang.String getStyle()
The CSS class for this element. Corresponds to the HTML 'class' attribute.

Specified by:
getStyle in interface org.apache.myfaces.component.StyleAware

getStyleClass

public abstract java.lang.String getStyleClass()
The CSS class for this element. Corresponds to the HTML 'class' attribute.

Specified by:
getStyleClass in interface org.apache.myfaces.component.StyleAware

getWidgetId

public abstract java.lang.String getWidgetId()
Optional enforced dojo widgetId

Specified by:
getWidgetId in interface org.apache.myfaces.custom.dojo.DojoWidget

getWidgetVar

public abstract java.lang.String getWidgetVar()
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

getScriptScope

public abstract java.lang.String getScriptScope()
Scopecontainer for downloaded Scripts



Copyright © 2011 The Apache Software Foundation. All Rights Reserved.