org.apache.myfaces.custom.dojo
Class DojoInitializer

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UIOutput
              org.apache.myfaces.custom.dojo.DojoInitializer

All Implemented Interfaces:

javax.faces.component.StateHolder, javax.faces.component.ValueHolder

public class DojoInitializer
extends javax.faces.component.UIOutput

Default component for the dojo intializer
This component is purely non visual, and serves for quick hacking, and prototyping the dojo toolkit within verbatimed html.
Dojo initializer helper tag for debugging and communication flags. This tag encapsules the Dojo DjConfig meta configuration and also adds the needed dojo required functionality.

Version:

$Revision: 672986 $ $Date: 2008-06-30 23:13:55 -0500 (Mon, 30 Jun 2008) $

Author:

Werner Punz (latest modification by $Author: lu4242 $)

Field Summary

static String	COMPONENT_FAMILY
static String	COMPONENT_TYPE
static String	DEFAULT_RENDERER_TYPE

Constructor Summary

DojoInitializer()

Method Summary

Boolean	getAllowQueryConfig() Triggers a standard dojo allowQueryConfig as defined by the Dojo Toolkit.
String	getBaseScriptUri() Triggers a standard dojo baseScriptUri as defined by the Dojo Toolkit Allows the alteration of the dojo loading root path used by require.
String	getBindEncoding() Triggers a standard dojo bindEncoding as defined by the Dojo Toolkit Although this control most of the times is not needed one usage in plain jsf applications can be thought of.
String	getComponentType()
Boolean	getDebug() Triggers a standard dojo debug as defined by the Dojo Toolkit Enables the dojo debugging framework.
Boolean	getDebugAtAllCosts() Triggers a standard dojo debugAtAllCosts as defined by the Dojo Toolkit Tries to enforce debugging even if the browser version does not allow it to work properlys
Boolean	getDebugConsole() Triggers a standard dojo debugConsole as defined by the Dojo Toolkit This flag pops up a separate in frame floating window which receives the debugging output.
String	getDebugContainerId() Triggers a standard dojo debugContainerId as defined by the Dojo Toolkit This flag notifies the Dojo toolkit about the id which should receive the debug output.
Boolean	getDevelopment() Triggers a standard dojo development as defined by the Dojo Toolkit If this parameter is set to true.
DojoConfig	getDojoConfig()
Boolean	getExpanded() Triggers a standard dojo development as defined by the Dojo Toolkit If you can find additional info about this attribute please fill in here
String	getFamily()
Boolean	getIgnoreClassNames() Triggers a standard dojo ignoreClassNames as defined by the Dojo Toolkit This attribute turns on the case insensitive handling of classnames by require and other Dojo class loader mechanisms.
String	getIoSendTransport() Dojo in its underlying architecture allows various options of server-client side communication.
Boolean	getParseWidgets() Triggers a standard dojo parseWidgets as defined by the Dojo Toolkit This parameter is used to turn on or off the dojo widgeting parsing.
Boolean	getPreventBackButtonFix() Dojo uses internally back button blockers to avoid problems with ajax requests causing the back button, to move out of the back page navigation order.
String	getProvide() Triggers a standard dojo provide as defined by the Dojo Toolkit
String	getRendererType()
String	getRequire() Triggers a standard dojo provide as defined by the Dojo Toolkit
String	getSearchIds() Triggers a standard dojo development as defined by the Dojo Toolkit If you can find additional info about this attribute please fill in here
Object	getValue()
boolean	isDojoConfigParamSet()
void	restoreState(javax.faces.context.FacesContext context, Object state)
Object	saveState(javax.faces.context.FacesContext context)
void	setAllowQueryConfig(Boolean allowQueryConfig)
void	setBaseScriptUri(String baseScriptUri)
void	setBindEncoding(String bindEncoding)
void	setDebug(Boolean debug)
void	setDebugAtAllCosts(Boolean debugAtAllCosts)
void	setDebugConsole(Boolean debugConsole)
void	setDebugContainerId(String debugContainerId)
void	setDevelopment(Boolean development)
void	setDojoConfigParamSet(boolean dojoConfigParamSet)
void	setExpanded(Boolean expanded)
void	setIgnoreClassNames(Boolean ignoreClassNames)
void	setIoSendTransport(String ioSendTransport)
void	setParseWidgets(Boolean parseWidgets)
void	setPreventBackButtonFix(Boolean preventBackButtonFix)
void	setProvide(String provide)
void	setRequire(String required)
void	setSearchIds(String searchIds)

Methods inherited from class javax.faces.component.UIOutput

getConverter, getLocalValue, 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, 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_TYPE

public static final String COMPONENT_TYPE

See Also:

Constant Field Values

DEFAULT_RENDERER_TYPE

public static final String DEFAULT_RENDERER_TYPE

See Also:

Constant Field Values

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY

See Also:

Constant Field Values

Constructor Detail

DojoInitializer

public DojoInitializer()

Method Detail

getAllowQueryConfig

public Boolean getAllowQueryConfig()

Triggers a standard dojo allowQueryConfig as defined by the Dojo Toolkit. If someone has additional infos about this tag, please fill in here.

getBaseScriptUri

public String getBaseScriptUri()

Triggers a standard dojo baseScriptUri as defined by the Dojo Toolkit

Allows the alteration of the dojo loading root path used by require.

getBindEncoding

public String getBindEncoding()

Triggers a standard dojo bindEncoding as defined by the Dojo Toolkit Although this control most of the times is not needed one usage in plain jsf applications can be thought of. The changing of the bind encodings, if you check the parameter list of the control ioSendTransport can be used to change this encoding to any encoding parameter needed. This can be used to change the internal ajax request encodings of various controls in a global manner.

getComponentType

public String getComponentType()

getDebug

public Boolean getDebug()

Triggers a standard dojo debug as defined by the Dojo Toolkit

Enables the dojo debugging framework. The usage of dojo.debug causes output to be displayed in either the current container or a target container, if one is set.

getDebugAtAllCosts

public Boolean getDebugAtAllCosts()

Triggers a standard dojo debugAtAllCosts as defined by the Dojo Toolkit
Tries to enforce debugging even if the browser version does not allow it to work properlys

getDebugConsole

public Boolean getDebugConsole()

Triggers a standard dojo debugConsole as defined by the Dojo Toolkit

This flag pops up a separate in frame floating window which receives the debugging output.

Note: This flag only works if debugging is enabled generally via the debug="true" flag set

getDebugContainerId

public String getDebugContainerId()

Triggers a standard dojo debugContainerId as defined by the Dojo Toolkit

This flag notifies the Dojo toolkit about the id which should receive the debug output. Dojo has a full debugging framework in it which allows to turn on debug output via a logging mechanism @see dojo.debug() for further references.

The debugging output is not limited to the current container triggering the debugging statement any container can receive the debugging output this flag is the flag which has to be set for setting a different target id for the debugging output.

getDojoConfig

public DojoConfig getDojoConfig()

getExpanded

public Boolean getExpanded()

Triggers a standard dojo development as defined by the Dojo Toolkit If you can find additional info about this attribute please fill in here

getFamily

public String getFamily()

Overrides:

getFamily in class javax.faces.component.UIOutput

getIgnoreClassNames

public Boolean getIgnoreClassNames()

Triggers a standard dojo ignoreClassNames as defined by the Dojo Toolkit

This attribute turns on the case insensitive handling of classnames by require and other Dojo class loader mechanisms.

Case sensitivity is by default turned on.

getIoSendTransport

public String getIoSendTransport()

Dojo in its underlying architecture allows various options of server-client side communication. This setting allows the alteration of the communication layer to a different protocol. Currently only in usage is xmlhttprequest, hence setting this encoding will not change too much. But different encodings like iframe are planned for the future.

getParseWidgets

public Boolean getParseWidgets()

Triggers a standard dojo parseWidgets as defined by the Dojo Toolkit This parameter is used to turn on or off the dojo widgeting parsing. The parsing is not used by MyFaces for various reasons, but can be used by your own html code.

For addititional information regarding the Dojo Toolkit widget parsing, visit the
Dojo Toolkit Homepage

getPreventBackButtonFix

public Boolean getPreventBackButtonFix()

Dojo uses internally back button blockers to avoid problems with ajax requests causing the back button, to move out of the back page navigation order. Sometimes this behavior is not wanted and can be turned off with this on a global scale;

getProvide

public String getProvide()

Triggers a standard dojo provide as defined by the Dojo Toolkit

getRendererType

public String getRendererType()

Overrides:

getRendererType in class javax.faces.component.UIComponentBase

getRequire

public String getRequire()

Triggers a standard dojo provide as defined by the Dojo Toolkit

getSearchIds

public String getSearchIds()

Triggers a standard dojo development as defined by the Dojo Toolkit If you can find additional info about this attribute please fill in here

getDevelopment

public Boolean getDevelopment()

Triggers a standard dojo development as defined by the Dojo Toolkit If this parameter is set to true. The expanded debuggable version of dojo is included if set to false the compressed one is included.

getValue

public Object getValue()

Specified by:

getValue in interface javax.faces.component.ValueHolder

Overrides:

getValue in class javax.faces.component.UIOutput

isDojoConfigParamSet

public boolean isDojoConfigParamSet()

restoreState

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

Specified by:

restoreState in interface javax.faces.component.StateHolder

Overrides:

restoreState in class javax.faces.component.UIOutput

saveState

public Object saveState(javax.faces.context.FacesContext context)

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class javax.faces.component.UIOutput

setAllowQueryConfig

public void setAllowQueryConfig(Boolean allowQueryConfig)

setBaseScriptUri

public void setBaseScriptUri(String baseScriptUri)

setBindEncoding

public void setBindEncoding(String bindEncoding)

setDebug

public void setDebug(Boolean debug)

setDebugAtAllCosts

public void setDebugAtAllCosts(Boolean debugAtAllCosts)

setDebugConsole

public void setDebugConsole(Boolean debugConsole)

setDebugContainerId

public void setDebugContainerId(String debugContainerId)

setDojoConfigParamSet

public void setDojoConfigParamSet(boolean dojoConfigParamSet)

setExpanded

public void setExpanded(Boolean expanded)

setIgnoreClassNames

public void setIgnoreClassNames(Boolean ignoreClassNames)

setIoSendTransport

public void setIoSendTransport(String ioSendTransport)

setParseWidgets

public void setParseWidgets(Boolean parseWidgets)

setPreventBackButtonFix

public void setPreventBackButtonFix(Boolean preventBackButtonFix)

setProvide

public void setProvide(String provide)

setRequire

public void setRequire(String required)

setSearchIds

public void setSearchIds(String searchIds)

setDevelopment

public void setDevelopment(Boolean development)