org.itsnat.core.tmpl

Interface ItsNatDocumentTemplate

All Superinterfaces:

ItsNatUserData, MarkupTemplate

All Known Subinterfaces:

ItsNatDroidDocumentTemplate

public interface ItsNatDocumentTemplate
extends MarkupTemplate

Represents a document (page) template. Concrete documents are created using this template.

Author:

Jose Maria Arranz Santamaria

See Also:

ItsNatServlet.registerItsNatDocumentTemplate(String,String,Object), ItsNatServlet.getItsNatDocumentTemplate(String)

Method Summary

Methods

Modifier and Type	Method and Description
void	addCreateItsNatComponentListener(CreateItsNatComponentListener listener) Adds a new user defined component factory.
void	addEventListener(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.
Object	getArtifact(String name) Returns the artifact with the specified name.
Object	getArtifact(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.
DateFormat	getDefaultDateFormat() Returns the default data format used by components such as ItsNatHTMLInputTextFormatted.
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(String name, Object value) Registers an artifact with the specified name.
Object	removeArtifact(String name) Removes the artifact with the specified name.
void	removeCreateItsNatComponentListener(CreateItsNatComponentListener listener) Removes the specified user defined component factory.
void	removeEventListener(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(DateFormat format) Sets the default data format used by components such as ItsNatHTMLInputTextFormatted.
void	setDefaultNumberFormat(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.

Methods inherited from interface org.itsnat.core.tmpl.MarkupTemplate

getEncoding, getItsNatServlet, getMIME, getName, getSource, isOnLoadCacheStaticNodes, setEncoding, setOnLoadCacheStaticNodes

Methods inherited from interface org.itsnat.core.ItsNatUserData

containsUserValueName, getUserValue, getUserValueNames, removeUserValue, setUserValue

Method Detail

isDebugMode

boolean isDebugMode()

Informs whether the debug mode is enabled.

The default value is defined by ItsNatServletConfig.isDebugMode()

Returns:

true if debug is enabled.

setDebugMode

void setDebugMode(boolean debugMode)

Sets the debug mode.

Parameters:

debugMode - true to set debug mode.

getClientErrorMode

int getClientErrorMode()

Returns the default client error mode.

The default value is defined by ItsNatServletConfig.getClientErrorMode()

Returns:

the default client error mode.

See Also:

setClientErrorMode(int)

setClientErrorMode

void setClientErrorMode(int mode)

Sets the default client error mode.

Parameters:

mode - the default client error mode.

See Also:

getClientErrorMode()

getCommMode

int getCommMode()

Returns the default communication mode, AJAX or SCRIPT, for events.

This feature only affects to non-XML documents with events enabled.

The default value is defined by ItsNatServletConfig.getCommMode()

Returns:

the communication mode.

See Also:

setCommMode(int), CommMode

setCommMode

void setCommMode(int commMode)

Sets the default communication mode, AJAX or SCRIPT, for events.

Parameters:

commMode - the new communication mode.

See Also:

getCommMode()

getEventTimeout

long getEventTimeout()

Returns the default timeout in client of asynchronous AJAX/SCRIPT events.

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()

Returns:

the timeout of asynchronous AJAX/SCRIPT events in milliseconds.

See Also:

setEventTimeout(long)

setEventTimeout

void setEventTimeout(long timeout)

Sets the default timeout of asynchronous AJAX/SCRIPT events.

Parameters:

timeout - the new timeout. If negative no timeout is defined.

See Also:

getEventTimeout()

getUseGZip

int getUseGZip()

Returns whether JavaScript code and/or markup sent to the client is automatically compressed if the browser accepts this encoding.

The default value is defined by ItsNatServletConfig.getUseGZip()

Returns:

the bitwise value containing whether gzip is used to encode JavaScript code and/or markup.

See Also:

setUseGZip(int)

setUseGZip

void setUseGZip(int value)

Sets whether JavaScript code and/or markup sent to the client is automatically compressed if the browser accepts this encoding.

A bitwise value must be used using UseGZip constants, for instance: setUseGZip(UseGZip.MARKUP | UseGZip.SCRIPT).

Parameters:

value - a bitwise value.

See Also:

getUseGZip(), UseGZip

isLoadScriptInline

boolean isLoadScriptInline()

Informs whether the initial JavaScript code is sent inline into the loaded page or is loaded externally.

This feature only affects to non-XML documents with scripting enabled.

The default value is defined by ItsNatServletConfig.isLoadScriptInline()

Returns:

true if fast mode is enabled.

See Also:

setLoadScriptInline(boolean)

setLoadScriptInline

void setLoadScriptInline(boolean value)

Sets the initial JavaScript code is sent inline into the loaded page or is loaded externally.

Parameters:

value - true to sent inline.

See Also:

isLoadScriptInline()

isFastLoadMode

boolean isFastLoadMode()

Informs whether the fast load mode is enabled.

This feature only affects to non-XML documents with scripting enabled.

The default value is defined by ItsNatServletConfig.isFastLoadMode()

Returns:

true if fast mode is enabled.

See Also:

setFastLoadMode(boolean)

setFastLoadMode

void setFastLoadMode(boolean fastLoadMode)

Sets whether fast load mode is used.

Parameters:

fastLoadMode - true to enable fast load.

See Also:

isFastLoadMode()

isNodeCacheEnabled

boolean isNodeCacheEnabled()

Informs whether the speed oriented node cache is enabled.

This feature only affects to non-XML documents with scripting enabled.

The default value is defined by ItsNatServletConfig.isNodeCacheEnabled()

Returns:

true if node cache is enabled.

See Also:

setNodeCacheEnabled(boolean)

setNodeCacheEnabled

void setNodeCacheEnabled(boolean enable)

Sets whether the speed oriented node cache is enabled.

Parameters:

enable - true to enable node cache.

See Also:

isNodeCacheEnabled()

isAutoBuildComponents

boolean isAutoBuildComponents()

Informs whether components are built automatically using the necessary markup declarations.

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()

Returns:

true if automatic component build is enabled.

See Also:

setAutoBuildComponents(boolean)

setAutoBuildComponents

void setAutoBuildComponents(boolean value)

Sets whether components are build automatically using the necessary markup declarations.

Parameters:

value - true to enable automatic component build.

See Also:

isAutoBuildComponents()

isUsePatternMarkupToRender

boolean isUsePatternMarkupToRender()

Informs whether dom utils and components use by default the original (saved as pattern) markup to render.

The default value is defined by ItsNatServletConfig.isUsePatternMarkupToRender()

Returns:

true if by default the original markup is used.

See Also:

setUsePatternMarkupToRender(boolean)

setUsePatternMarkupToRender

void setUsePatternMarkupToRender(boolean value)

Sets whether dom utils and components use by default the original (saved as pattern) markup to render.

Parameters:

value - true to enable the use of original markup to render.

See Also:

isUsePatternMarkupToRender()

getDefaultDateFormat

DateFormat getDefaultDateFormat()

Returns the default data format used by components such as ItsNatHTMLInputTextFormatted.

The default value is defined by ItsNatServletConfig.getDefaultDateFormat()

Returns:

the default date format.

See Also:

setDefaultDateFormat(DateFormat)

setDefaultDateFormat

void setDefaultDateFormat(DateFormat format)

Sets the default data format used by components such as ItsNatHTMLInputTextFormatted.

Parameters:

format - the default data format.

See Also:

getDefaultDateFormat()

getDefaultNumberFormat

NumberFormat getDefaultNumberFormat()

Returns the default number format used by components such as ItsNatHTMLInputTextFormatted.

The default value is defined by ItsNatServletConfig.getDefaultNumberFormat()

Returns:

the default data format.

See Also:

setDefaultNumberFormat(NumberFormat)

setDefaultNumberFormat

void setDefaultNumberFormat(NumberFormat format)

Sets the default data format used by components such as ItsNatHTMLInputTextFormatted.

Parameters:

format - the default data format.

See Also:

getDefaultNumberFormat()

getEventDispatcherMaxWait

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.

This feature only affects to non-XML documents with events enabled.

The default value is defined by ItsNatServletConfig.getEventDispatcherMaxWait()

Returns:

the default max wait in milliseconds.

See Also:

setEventDispatcherMaxWait(long)

setEventDispatcherMaxWait

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.

Parameters:

wait - the default max wait in milliseconds.

See Also:

getEventDispatcherMaxWait()

getMaxOpenClientsByDocument

int getMaxOpenClientsByDocument()

Returns the max number of open clients (owner and attached) associated to a document in server.

This feature only affects to non-XML documents with events enabled

The default value is defined by ItsNatServletConfig.getMaxOpenClientsByDocument()

Returns:

the max number of open clients. Defaults to 10.

See Also:

setMaxOpenClientsByDocument(int)

setMaxOpenClientsByDocument

void setMaxOpenClientsByDocument(int value)

Sets the max number of open clients (owner and attached) associated to a document in server.

Parameters:

value - the new max number of open clients.

See Also:

getMaxOpenClientsByDocument()

isReferrerEnabled

boolean isReferrerEnabled()

Informs whether referrer feature is enabled by default.

The default value is defined by ItsNatServletConfig.isReferrerEnabled()

This feature only affects to non-XML documents with events enabled.

Returns:

true if referrer is enabled.

See Also:

setReferrerEnabled(boolean), isEventsEnabled(), ItsNatServletRequest.getItsNatDocumentReferrer()

setReferrerEnabled

void setReferrerEnabled(boolean enabled)

Sets whether referrer feature is enabled by default.

Parameters:

enabled - if referrer is enabled.

See Also:

isReferrerEnabled()

isReferrerPushEnabled

boolean isReferrerPushEnabled()

Informs whether referrer "push" feature is enabled by default.

The default value is defined by ItsNatServletConfig.isReferrerPushEnabled()

Returns:

true if referrer "push" is enabled, if false documents created with this template can not be accessed by the referrer.

See Also:

setReferrerPushEnabled(boolean), isReferrerEnabled(), ItsNatDocument.addReferrerItsNatServletRequestListener(ItsNatServletRequestListener)

setReferrerPushEnabled

void setReferrerPushEnabled(boolean enabled)

Sets whether referrer "push" feature is enabled by default.

Parameters:

enabled - if referrer "push" is enabled.

See Also:

isReferrerPushEnabled()

isEventsEnabled

boolean isEventsEnabled()

Informs whether events (AJAX or SCRIPT based) are enabled.

The default value is defined by ItsNatServletConfig.isEventsEnabled()

This feature only affects to non-XML documents.

Returns:

true if events are enabled.

See Also:

setEventsEnabled(boolean)

setEventsEnabled

void setEventsEnabled(boolean enabled)

Sets whether events (AJAX or SCRIPT based) are enabled.

Parameters:

enabled - if events are enabled.

See Also:

isEventsEnabled()

isScriptingEnabled

boolean isScriptingEnabled()

Informs whether JavaScript is enabled.

The default value is defined by ItsNatServletConfig.isScriptingEnabled()

This feature only affects to non-XML documents.

Returns:

true if scripting is enabled.

See Also:

setScriptingEnabled(boolean)

setScriptingEnabled

void setScriptingEnabled(boolean enabled)

Sets whether JavaScript is enabled.

If JavaScript is disabled then events are also disabled.

Parameters:

enabled - if JavaScript is enabled.

See Also:

isScriptingEnabled(), setEventsEnabled(boolean)

isAutoCleanEventListeners

boolean isAutoCleanEventListeners()

Informs whether the auto clean event listeners mode is enabled.

The default value is defined by ItsNatServletConfig.isAutoCleanEventListeners()

This feature only affects to non-XML documents.

Returns:

true if enabled.

See Also:

setAutoCleanEventListeners(boolean)

setAutoCleanEventListeners

void setAutoCleanEventListeners(boolean enabled)

Sets whether the auto clean event listeners mode is enabled.

Parameters:

enabled - if auto clean event listeners is enabled.

See Also:

isAutoCleanEventListeners()

isUseXHRSyncOnUnloadEvent

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.

The default value is defined by ItsNatServletConfig.isUseXHRSyncOnUnloadEvent()

This feature only affects to non-XML documents.

Returns:

true if enabled.

See Also:

setUseXHRSyncOnUnloadEvent(boolean)

setUseXHRSyncOnUnloadEvent

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.

Parameters:

enabled - if unload event is sent synchronously in AJAX mode.

See Also:

isUseXHRSyncOnUnloadEvent()

isSelectionOnComponentsUsesKeyboard

boolean isSelectionOnComponentsUsesKeyboard()

Informs whether the keyboard is necessary for selection on components.

The default value is defined by ItsNatServletConfig.isSelectionOnComponentsUsesKeyboard()

This feature only affects to non-XML documents with events enabled.

Returns:

true if selection uses keyboard.

See Also:

setSelectionOnComponentsUsesKeyboard(boolean)

setSelectionOnComponentsUsesKeyboard

void setSelectionOnComponentsUsesKeyboard(boolean value)

Informs whether the keyboard is necessary for selection on components

Parameters:

value - true to specify the keyboard is necessary for selection.

See Also:

isSelectionOnComponentsUsesKeyboard()

isJoystickMode

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).

The default value is defined by ItsNatServletConfig.isJoystickMode()

This feature only affects to non-XML documents with events enabled.

Returns:

true if joystick mode is on.

See Also:

setJoystickMode(boolean)

setJoystickMode

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).

Parameters:

value - true to enable joystick mode.

See Also:

isJoystickMode()

isMarkupDrivenComponents

boolean isMarkupDrivenComponents()

Informs whether markup driven mode is used in components.

The default value is defined by ItsNatServletConfig.isMarkupDrivenComponents()

This feature only affects to some HTML form based components.

Returns:

true if components are markup driven.

See Also:

setMarkupDrivenComponents(boolean)

setMarkupDrivenComponents

void setMarkupDrivenComponents(boolean value)

Sets whether markup driven mode is used in components.

Parameters:

value - true to enable markup driven.

See Also:

isMarkupDrivenComponents()

addItsNatServletRequestListener

void addItsNatServletRequestListener(ItsNatServletRequestListener listener)

Registers a new ItsNat request listener. This listener is called when the framework loads a new requested document using this template or an event is received with a document target loaded by this template.

Parameters:

listener - the listener register.

See Also:

removeItsNatServletRequestListener(ItsNatServletRequestListener), ItsNatServlet.addItsNatServletRequestListener(ItsNatServletRequestListener)

removeItsNatServletRequestListener

void removeItsNatServletRequestListener(ItsNatServletRequestListener listener)

Unregisters the specified user defined request listener.

Parameters:

listener - the request listener to remove.

See Also:

addItsNatServletRequestListener(ItsNatServletRequestListener)

addItsNatAttachedClientEventListener

void addItsNatAttachedClientEventListener(ItsNatAttachedClientEventListener listener)

Adds a remote control listener to this template. This listener is called when a remote view/control is requested to control a document loaded using this template.

The listener is called before calling the document registered listener counterparts (if defined).

Parameters:

listener - the listener to add.

See Also:

removeItsNatAttachedClientEventListener(ItsNatAttachedClientEventListener), ItsNatServlet.addItsNatAttachedClientEventListener(ItsNatAttachedClientEventListener), ItsNatDocument.addItsNatAttachedClientEventListener(ItsNatAttachedClientEventListener)

removeItsNatAttachedClientEventListener

void removeItsNatAttachedClientEventListener(ItsNatAttachedClientEventListener listener)

Removes the specified remote control listener.

Parameters:

listener - the listener to remove.

See Also:

addItsNatAttachedClientEventListener(ItsNatAttachedClientEventListener)

addEventListener

void addEventListener(EventListener listener)

Adds a global event listener to this template. This listener is called when any DOM event (standard or extended) is received by a document loaded using this template.

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.

Parameters:

listener - the listener to add.

See Also:

removeEventListener(EventListener), ItsNatServlet.addEventListener(EventListener), ItsNatDocument.addEventListener(EventListener)

removeEventListener

void removeEventListener(EventListener listener)

Removes the specified global event listener registered in this template.

Parameters:

listener - the listener to remove.

See Also:

addEventListener(EventListener)

addCreateItsNatComponentListener

void addCreateItsNatComponentListener(CreateItsNatComponentListener listener)

Adds a new user defined component factory. This listener is called when the framework needs to create a component instance.

Parameters:

listener - the listener factory to register.

See Also:

removeCreateItsNatComponentListener(CreateItsNatComponentListener), ItsNatServlet.addCreateItsNatComponentListener(CreateItsNatComponentListener)

removeCreateItsNatComponentListener

void removeCreateItsNatComponentListener(CreateItsNatComponentListener listener)

Removes the specified user defined component factory.

Parameters:

listener - the listener factory to remove.

See Also:

addCreateItsNatComponentListener(CreateItsNatComponentListener)

registerArtifact

void registerArtifact(String name,
                    Object value)

Registers an artifact with the specified name.

Parameters:

name - the artifact name

value - the artifact.

See Also:

getArtifact(String), removeArtifact(String), NameValue

getArtifact

Object getArtifact(String name)

Returns the artifact with the specified name.

Parameters:

name - the artifact name to look for.

Returns:

the artifact or null if not found.

See Also:

registerArtifact(String,Object), getArtifact(String,boolean)

removeArtifact

Object removeArtifact(String name)

Removes the artifact with the specified name.

Parameters:

name - the artifact name to look for.

Returns:

the removed artifact.

See Also:

registerArtifact(String,Object)

getArtifact

Object getArtifact(String name,
                 boolean cascade)

Returns the artifact with the specified name.

If no artifact is found and cascade is true, the method ItsNatServletConfig.getArtifact(String) is called to continue searching.

Parameters:

name - the artifact name to look for.

Returns:

the artifact or null if not found.

See Also:

getArtifact(String)