public interface ItsNatDocumentTemplate extends MarkupTemplate
ItsNatServlet.registerItsNatDocumentTemplate(String,String,Object)
,
ItsNatServlet.getItsNatDocumentTemplate(String)
Modifier and Type | Method and Description |
---|---|
void |
addCreateItsNatComponentListener(CreateItsNatComponentListener listener)
Adds a new user defined component factory.
|
void |
addEventListener(org.w3c.dom.events.EventListener listener)
Adds a global event listener to this template.
|
void |
addItsNatAttachedClientEventListener(ItsNatAttachedClientEventListener listener)
Adds a remote control listener to this template.
|
void |
addItsNatServletRequestListener(ItsNatServletRequestListener listener)
Registers a new ItsNat request listener.
|
java.lang.Object |
getArtifact(java.lang.String name)
Returns the artifact with the specified name.
|
java.lang.Object |
getArtifact(java.lang.String name,
boolean cascade)
Returns the artifact with the specified name.
|
int |
getClientErrorMode()
Returns the default client error mode.
|
int |
getCommMode()
Returns the default communication mode, AJAX or SCRIPT, for events.
|
java.text.DateFormat |
getDefaultDateFormat()
Returns the default data format used by components such as
ItsNatHTMLInputTextFormatted . |
java.text.NumberFormat |
getDefaultNumberFormat()
Returns the default number format used by components such as
ItsNatHTMLInputTextFormatted . |
long |
getEventDispatcherMaxWait()
Returns the default max wait until a server fired event with
ItsNatDocument.dispatchEvent(org.w3c.dom.events.EventTarget,org.w3c.dom.events.Event)
is processed by the client and returns. |
long |
getEventTimeout()
Returns the default timeout in client of asynchronous AJAX/SCRIPT events.
|
int |
getMaxOpenClientsByDocument()
Returns the max number of open clients (owner and attached) associated to a document in server.
|
int |
getUseGZip()
Returns whether JavaScript code and/or markup sent to the client is
automatically compressed if the browser accepts this encoding.
|
boolean |
isAutoBuildComponents()
Informs whether components are built automatically using the necessary
markup declarations.
|
boolean |
isAutoCleanEventListeners()
Informs whether the auto clean event listeners mode is enabled.
|
boolean |
isDebugMode()
Informs whether the debug mode is enabled.
|
boolean |
isEventsEnabled()
Informs whether events (AJAX or SCRIPT based) are enabled.
|
boolean |
isFastLoadMode()
Informs whether the fast load mode is enabled.
|
boolean |
isJoystickMode()
Informs whether a joystick is enough to control, for instance, components
(some kind of mouse, pointer or stylus not present or not necessary).
|
boolean |
isLoadScriptInline()
Informs whether the initial JavaScript code is sent inline into the loaded page
or is loaded externally.
|
boolean |
isMarkupDrivenComponents()
Informs whether markup driven mode is used in components.
|
boolean |
isNodeCacheEnabled()
Informs whether the speed oriented node cache is enabled.
|
boolean |
isReferrerEnabled()
Informs whether referrer feature is enabled by default.
|
boolean |
isReferrerPushEnabled()
Informs whether referrer "push" feature is enabled by default.
|
boolean |
isScriptingEnabled()
Informs whether JavaScript is enabled.
|
boolean |
isSelectionOnComponentsUsesKeyboard()
Informs whether the keyboard is necessary for selection on components.
|
boolean |
isUsePatternMarkupToRender()
Informs whether dom utils and components use by default the original
(saved as pattern) markup to render.
|
boolean |
isUseXHRSyncOnUnloadEvent()
Informs whether the internal unload event sent by ItsNat when end user leaves the page,
is synchronously sent when the transport is AJAX (XMLHttpRequest) mode by default.
|
void |
registerArtifact(java.lang.String name,
java.lang.Object value)
Registers an artifact with the specified name.
|
java.lang.Object |
removeArtifact(java.lang.String name)
Removes the artifact with the specified name.
|
void |
removeCreateItsNatComponentListener(CreateItsNatComponentListener listener)
Removes the specified user defined component factory.
|
void |
removeEventListener(org.w3c.dom.events.EventListener listener)
Removes the specified global event listener registered in this template.
|
void |
removeItsNatAttachedClientEventListener(ItsNatAttachedClientEventListener listener)
Removes the specified remote control listener.
|
void |
removeItsNatServletRequestListener(ItsNatServletRequestListener listener)
Unregisters the specified user defined request listener.
|
void |
setAutoBuildComponents(boolean value)
Sets whether components are build automatically using the necessary
markup declarations.
|
void |
setAutoCleanEventListeners(boolean enabled)
Sets whether the auto clean event listeners mode is enabled.
|
void |
setClientErrorMode(int mode)
Sets the default client error mode.
|
void |
setCommMode(int commMode)
Sets the default communication mode, AJAX or SCRIPT, for events.
|
void |
setDebugMode(boolean debugMode)
Sets the debug mode.
|
void |
setDefaultDateFormat(java.text.DateFormat format)
Sets the default data format used by components such as
ItsNatHTMLInputTextFormatted . |
void |
setDefaultNumberFormat(java.text.NumberFormat format)
Sets the default data format used by components such as
ItsNatHTMLInputTextFormatted . |
void |
setEventDispatcherMaxWait(long wait)
Sets the default max wait until a server fired event with
ItsNatDocument.dispatchEvent(org.w3c.dom.events.EventTarget,org.w3c.dom.events.Event)
is processed by the client and returns. |
void |
setEventsEnabled(boolean enabled)
Sets whether events (AJAX or SCRIPT based) are enabled.
|
void |
setEventTimeout(long timeout)
Sets the default timeout of asynchronous AJAX/SCRIPT events.
|
void |
setFastLoadMode(boolean fastLoadMode)
Sets whether fast load mode is used.
|
void |
setJoystickMode(boolean value)
Informs whether a joystick is enough to control, for instance, components
(some kind of mouse, pointer or stylus not present or not necessary).
|
void |
setLoadScriptInline(boolean value)
Sets the initial JavaScript code is sent inline into the loaded page
or is loaded externally.
|
void |
setMarkupDrivenComponents(boolean value)
Sets whether markup driven mode is used in components.
|
void |
setMaxOpenClientsByDocument(int value)
Sets the max number of open clients (owner and attached) associated to a document in server.
|
void |
setNodeCacheEnabled(boolean enable)
Sets whether the speed oriented node cache is enabled.
|
void |
setReferrerEnabled(boolean enabled)
Sets whether referrer feature is enabled by default.
|
void |
setReferrerPushEnabled(boolean enabled)
Sets whether referrer "push" feature is enabled by default.
|
void |
setScriptingEnabled(boolean enabled)
Sets whether JavaScript is enabled.
|
void |
setSelectionOnComponentsUsesKeyboard(boolean value)
Informs whether the keyboard is necessary for selection on components
|
void |
setUseGZip(int value)
Sets whether JavaScript code and/or markup sent to the client is
automatically compressed if the browser accepts this encoding.
|
void |
setUsePatternMarkupToRender(boolean value)
Sets whether dom utils and components use by default the original
(saved as pattern) markup to render.
|
void |
setUseXHRSyncOnUnloadEvent(boolean enabled)
Sets whether the internal unload event sent by ItsNat when end user leaves the page,
is synchronously sent when the transport is AJAX (XMLHttpRequest) mode by default.
|
getEncoding, getItsNatServlet, getMIME, getName, getSource, isOnLoadCacheStaticNodes, setEncoding, setOnLoadCacheStaticNodes
containsUserValueName, getUserValue, getUserValueNames, removeUserValue, setUserValue
boolean isDebugMode()
The default value is defined by ItsNatServletConfig.isDebugMode()
void setDebugMode(boolean debugMode)
debugMode
- true to set debug mode.int getClientErrorMode()
The default value is defined by ItsNatServletConfig.getClientErrorMode()
setClientErrorMode(int)
void setClientErrorMode(int mode)
mode
- the default client error mode.getClientErrorMode()
int getCommMode()
This feature only affects to non-XML documents with events enabled.
The default value is defined by ItsNatServletConfig.getCommMode()
setCommMode(int)
,
CommMode
void setCommMode(int commMode)
commMode
- the new communication mode.getCommMode()
long getEventTimeout()
This feature only affects to non-XML documents with events enabled and is ignored in synchronous AJAX events
When an unfinished request takes more time than the specified timeout, the request is aborted.
The default value is defined by ItsNatServletConfig.getEventTimeout()
setEventTimeout(long)
void setEventTimeout(long timeout)
timeout
- the new timeout. If negative no timeout is defined.getEventTimeout()
int getUseGZip()
The default value is defined by ItsNatServletConfig.getUseGZip()
setUseGZip(int)
void setUseGZip(int value)
A bitwise value must be used using UseGZip
constants, for instance:
setUseGZip(UseGZip.MARKUP | UseGZip.SCRIPT).
value
- a bitwise value.getUseGZip()
,
UseGZip
boolean isLoadScriptInline()
This feature only affects to non-XML documents with scripting enabled.
The default value is defined by ItsNatServletConfig.isLoadScriptInline()
setLoadScriptInline(boolean)
void setLoadScriptInline(boolean value)
value
- true to sent inline.isLoadScriptInline()
boolean isFastLoadMode()
This feature only affects to non-XML documents with scripting enabled.
The default value is defined by ItsNatServletConfig.isFastLoadMode()
setFastLoadMode(boolean)
void setFastLoadMode(boolean fastLoadMode)
fastLoadMode
- true to enable fast load.isFastLoadMode()
boolean isNodeCacheEnabled()
This feature only affects to non-XML documents with scripting enabled.
The default value is defined by ItsNatServletConfig.isNodeCacheEnabled()
setNodeCacheEnabled(boolean)
void setNodeCacheEnabled(boolean enable)
enable
- true to enable node cache.isNodeCacheEnabled()
boolean isAutoBuildComponents()
If this feature is enabled the initial document tree is automatically traversed, any component declared in markup is automatically built and registered into the component manager associated to a DOM element, including DOM elements added to the tree in any time.
When a node is removed from the tree the associated component, if any, is removed and disposed automatically.
The default value is defined by ItsNatServletConfig.isAutoBuildComponents()
setAutoBuildComponents(boolean)
void setAutoBuildComponents(boolean value)
value
- true to enable automatic component build.isAutoBuildComponents()
boolean isUsePatternMarkupToRender()
The default value is defined by ItsNatServletConfig.isUsePatternMarkupToRender()
setUsePatternMarkupToRender(boolean)
void setUsePatternMarkupToRender(boolean value)
value
- true to enable the use of original markup to render.isUsePatternMarkupToRender()
java.text.DateFormat getDefaultDateFormat()
ItsNatHTMLInputTextFormatted
.
The default value is defined by ItsNatServletConfig.getDefaultDateFormat()
setDefaultDateFormat(DateFormat)
void setDefaultDateFormat(java.text.DateFormat format)
ItsNatHTMLInputTextFormatted
.format
- the default data format.getDefaultDateFormat()
java.text.NumberFormat getDefaultNumberFormat()
ItsNatHTMLInputTextFormatted
.
The default value is defined by ItsNatServletConfig.getDefaultNumberFormat()
setDefaultNumberFormat(NumberFormat)
void setDefaultNumberFormat(java.text.NumberFormat format)
ItsNatHTMLInputTextFormatted
.format
- the default data format.getDefaultNumberFormat()
long getEventDispatcherMaxWait()
ItsNatDocument.dispatchEvent(org.w3c.dom.events.EventTarget,org.w3c.dom.events.Event)
is processed by the client and returns.
This feature only affects to non-XML documents with events enabled.
The default value is defined by ItsNatServletConfig.getEventDispatcherMaxWait()
setEventDispatcherMaxWait(long)
void setEventDispatcherMaxWait(long wait)
ItsNatDocument.dispatchEvent(org.w3c.dom.events.EventTarget,org.w3c.dom.events.Event)
is processed by the client and returns.wait
- the default max wait in milliseconds.getEventDispatcherMaxWait()
int getMaxOpenClientsByDocument()
This feature only affects to non-XML documents with events enabled
The default value is defined by ItsNatServletConfig.getMaxOpenClientsByDocument()
setMaxOpenClientsByDocument(int)
void setMaxOpenClientsByDocument(int value)
value
- the new max number of open clients.getMaxOpenClientsByDocument()
boolean isReferrerEnabled()
The default value is defined by ItsNatServletConfig.isReferrerEnabled()
This feature only affects to non-XML documents with events enabled.
setReferrerEnabled(boolean)
,
isEventsEnabled()
,
ItsNatServletRequest.getItsNatDocumentReferrer()
void setReferrerEnabled(boolean enabled)
enabled
- if referrer is enabled.isReferrerEnabled()
boolean isReferrerPushEnabled()
The default value is defined by ItsNatServletConfig.isReferrerPushEnabled()
setReferrerPushEnabled(boolean)
,
isReferrerEnabled()
,
ItsNatDocument.addReferrerItsNatServletRequestListener(ItsNatServletRequestListener)
void setReferrerPushEnabled(boolean enabled)
enabled
- if referrer "push" is enabled.isReferrerPushEnabled()
boolean isEventsEnabled()
The default value is defined by ItsNatServletConfig.isEventsEnabled()
This feature only affects to non-XML documents.
setEventsEnabled(boolean)
void setEventsEnabled(boolean enabled)
enabled
- if events are enabled.isEventsEnabled()
boolean isScriptingEnabled()
The default value is defined by ItsNatServletConfig.isScriptingEnabled()
This feature only affects to non-XML documents.
setScriptingEnabled(boolean)
void setScriptingEnabled(boolean enabled)
If JavaScript is disabled then events are also disabled.
enabled
- if JavaScript is enabled.isScriptingEnabled()
,
setEventsEnabled(boolean)
boolean isAutoCleanEventListeners()
The default value is defined by ItsNatServletConfig.isAutoCleanEventListeners()
This feature only affects to non-XML documents.
setAutoCleanEventListeners(boolean)
void setAutoCleanEventListeners(boolean enabled)
enabled
- if auto clean event listeners is enabled.isAutoCleanEventListeners()
boolean isUseXHRSyncOnUnloadEvent()
The default value is defined by ItsNatServletConfig.isUseXHRSyncOnUnloadEvent()
This feature only affects to non-XML documents.
setUseXHRSyncOnUnloadEvent(boolean)
void setUseXHRSyncOnUnloadEvent(boolean enabled)
enabled
- if unload event is sent synchronously in AJAX mode.isUseXHRSyncOnUnloadEvent()
boolean isSelectionOnComponentsUsesKeyboard()
The default value is defined by ItsNatServletConfig.isSelectionOnComponentsUsesKeyboard()
This feature only affects to non-XML documents with events enabled.
setSelectionOnComponentsUsesKeyboard(boolean)
void setSelectionOnComponentsUsesKeyboard(boolean value)
value
- true to specify the keyboard is necessary for selection.isSelectionOnComponentsUsesKeyboard()
boolean isJoystickMode()
The default value is defined by ItsNatServletConfig.isJoystickMode()
This feature only affects to non-XML documents with events enabled.
setJoystickMode(boolean)
void setJoystickMode(boolean value)
value
- true to enable joystick mode.isJoystickMode()
boolean isMarkupDrivenComponents()
The default value is defined by ItsNatServletConfig.isMarkupDrivenComponents()
This feature only affects to some HTML form based components.
setMarkupDrivenComponents(boolean)
void setMarkupDrivenComponents(boolean value)
value
- true to enable markup driven.isMarkupDrivenComponents()
void addItsNatServletRequestListener(ItsNatServletRequestListener listener)
listener
- the listener register.removeItsNatServletRequestListener(ItsNatServletRequestListener)
,
ItsNatServlet.addItsNatServletRequestListener(ItsNatServletRequestListener)
void removeItsNatServletRequestListener(ItsNatServletRequestListener listener)
listener
- the request listener to remove.addItsNatServletRequestListener(ItsNatServletRequestListener)
void addItsNatAttachedClientEventListener(ItsNatAttachedClientEventListener listener)
The listener is called before calling the document registered listener counterparts (if defined).
listener
- the listener to add.removeItsNatAttachedClientEventListener(ItsNatAttachedClientEventListener)
,
ItsNatServlet.addItsNatAttachedClientEventListener(ItsNatAttachedClientEventListener)
,
ItsNatDocument.addItsNatAttachedClientEventListener(ItsNatAttachedClientEventListener)
void removeItsNatAttachedClientEventListener(ItsNatAttachedClientEventListener listener)
listener
- the listener to remove.addItsNatAttachedClientEventListener(ItsNatAttachedClientEventListener)
void addEventListener(org.w3c.dom.events.EventListener listener)
The listener is called before calling any DOM event listener registered in documents based on this template. This listener registry is passive, in no way the client is modified (no listener is registered on the client) and usually used for monitoring.
listener
- the listener to add.removeEventListener(EventListener)
,
ItsNatServlet.addEventListener(EventListener)
,
ItsNatDocument.addEventListener(EventListener)
void removeEventListener(org.w3c.dom.events.EventListener listener)
listener
- the listener to remove.addEventListener(EventListener)
void addCreateItsNatComponentListener(CreateItsNatComponentListener listener)
listener
- the listener factory to register.removeCreateItsNatComponentListener(CreateItsNatComponentListener)
,
ItsNatServlet.addCreateItsNatComponentListener(CreateItsNatComponentListener)
void removeCreateItsNatComponentListener(CreateItsNatComponentListener listener)
listener
- the listener factory to remove.addCreateItsNatComponentListener(CreateItsNatComponentListener)
void registerArtifact(java.lang.String name, java.lang.Object value)
name
- the artifact namevalue
- the artifact.getArtifact(String)
,
removeArtifact(String)
,
NameValue
java.lang.Object getArtifact(java.lang.String name)
name
- the artifact name to look for.registerArtifact(String,Object)
,
getArtifact(String,boolean)
java.lang.Object removeArtifact(java.lang.String name)
name
- the artifact name to look for.registerArtifact(String,Object)
java.lang.Object getArtifact(java.lang.String name, boolean cascade)
If no artifact is found and cascade
is true,
the method ItsNatServletConfig.getArtifact(String)
is called to continue searching.
name
- the artifact name to look for.getArtifact(String)
Copyright © 2007 Innowhere Software Services S.L. All Rights Reserved.