Description
A control which allows to dock the Dojo Toolkit This component is purely non visual, and serves for quick hacking, and prototyping the dojo toolkit within verbatimed html.
Its goal is to hide the underlying complexities of the initialization process of the underlying dojo toolkit
API
author | Werner Punz |
component-family | javax.faces.Output |
renderer-type | org.apache.myfaces.DojoInitializerRenderer |
component-class | org.apache.myfaces.custom.dojo.DojoInitializer |
renderer-class | org.apache.myfaces.custom.dojo.DojoInitializerRenderer |
tag-class | org.apache.myfaces.custom.dojo.DojoInitializerTag |
Usage
<t:dojoInitializer > [rendered="true|false"] [allowQueryConfig="true|false"] [baseScriptUri="<some uri>"] [bindEncoding="utf8|iso8859-1|iso-8859-15|..."] [debug="true|false"] [debugAtAllCosts="true|false"] [debugConsole="true|false"] [debugContainerId="<some id of an existing defined container >"] [development="true|false"] [expanded="true|false"] [ignoreClassNames="true|false"] [ioSendTransport="xmlhttrequest"] [parseWidgets="true|false"] [preventBackButtonFix="true|false"] [provide="<dojo class with package>"] [require="<dojo class with package>"] [searchIds="<some id of an existing defined container >"] [development="true|false"] </t:dojoInitializer>
Additional Information
see dojo/*.jsp in the Sandbox examples.
rendered
Standard jsf rendered attribute
allowQueryConfig
Triggers a standard dojo allowQueryConfig as defined
by the
Dojo Toolkit
If someone has additional infos about this tag,
please fill in here
baseScriptUri
Triggers a standard dojo baseScriptUri as defined by
the
Dojo Toolkit
Allows the alteration of the dojo loading root path
used by require.
debug
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.
debugAtAllCosts
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
debugConsole
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
debugContainerId
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.
development Triggers a standard dojo development as defined by the Dojo Toolkit If you can find additional info about this attribute please fill in here
expanded Triggers a standard dojo expanded as defined by the Dojo Toolkit If you can find additional info about this attribute please fill in here
ignoreClassNames
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
.
searchIds Triggers a standard dojo searchIds as defined by the Dojo Toolkit If you can find out additional info about this parameter fill in the info here.
parseWidgets
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
provide Triggers a standard dojo provide as defined by the Dojo Toolkit
require Triggers a standard dojo require as defined by the Dojo Toolkit
preventBackButtonFix 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;
bindEncoding 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.
ioSendTransport
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.
development
If this parameter is set to true. The expanded
debuggable version of dojo is included
if set to false the compressed one is included.