Java Doc for ItsNatDocument.java in  » Ajax » ItsNat » org » itsnat » core » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Provides many useful utilities to simulate "The Browser Is The Server" approach of ItsNat like event listener registries. Is the factory of DOM utility objects and ItsNat components.

ItsNat document objects are created using a DocumentTemplate as pattern and usually obtained calling ItsNatServletRequest.getItsNatDocument or ItsNatServletResponse.getItsNatDocument when a new document (page) is loading or calling org.itsnat.core.event.ItsNatEvent.getItsNatDocument when an AJAX event is received.

Is not thread save and any object depending on this document (DOM utility objects, components etc) is not thread save too. This is not a problem because any ItsNat request/response thread synchronizes this object before calling user defined code, user defined code executed by an ItsNat request/response thread may be unaware of synchronization isues.

If no artifact is found and cascade is true, the method DocumentTemplate.getArtifact(Stringboolean) is called with cascade set to true to continue searching.

The default value is defined by DocumentTemplate.getDefaultDateFormat

The default value is defined by DocumentTemplate.getDefaultNumberFormat

If lockDoc is true this document is synchronized during the task execution, but if lockDoc is false the task code must synchronize the document before any access.

In a long running task is highly recommended to set lockDoc as false to avoid a long document lock.

When this listener is registered the server sends custom JavaScript code to fire automatically a org.itsnat.core.event.ContinueEvent sent to the listener. This event usually carries client data necesary to continue a pending server task (and any JavaScript code sent to the client prior to register the listener was executed, this new client state may be the carried data if any).

There is no "remove listener" method because the listener is automatically removed when receives and processes the event.

When this listener is registered the server sends custom JavaScript code to register a handler in the client side with the specified node target and DOM event type. When an event is fired this handler forwards the client event to the server and the registered listener receives an org.w3c.dom.events.Event with the same client event data.

If two or more listeners are registered sharing the same node target and event type, they all will receive the same event.

When a mutation event is received, this event carries the necessary data to synchronize the server target element with the client. After this automatic synchronization the listener is called.

Current implementation does the following:

 ParamTransport[] params = new ParamTransport[]{ new ClientMutation() };
 addEventListener(target,"DOMAttrModified",listener,useCapture,syncMode,params,preSendCode,ajaxTimeout);
 addEventListener(target,"DOMNodeInserted",listener,useCapture,syncMode,params,preSendCode,ajaxTimeout);
 addEventListener(target,"DOMNodeRemoved",listener,useCapture,syncMode,params,preSendCode,ajaxTimeout);
 addEventListener(target,"DOMCharacterDataModified",listener,useCapture,syncMode,params,preSendCode,ajaxTimeout);        
 

If the target is the org.w3c.dom.Document object, every document change in the client us automatically synchronized in the server.

Mutation events only works with Mozilla/FireFox (MSIE 6 does not support W3C DOM mutation events).

When this listener is registered the server sends custom JavaScript code to register a handler in the client side with the specified node target and name.

User events are fired in the client calling the ItsNat JavaScript method fireUserEvent(targetNode,name,args). For instance:

Target node and name must be the same parameters used to register the listener. org.itsnat.core.event.ParamTransport objects may be used to transport client data (args parameter).

If two or more listeners are registered sharing the same node target and name, they all will receive the same event fired by fireUserEvent with this target/name pair.

This method calls ItsNatDocument.addUserEventListener(EventTarget,String,EventListener,int,ParamTransport[],String,long) with the document default values (sync mode, AJAX timeout) and no extra parameters and custom code.

The reference manual explains with examples how this default structure works.

If the current thread was not started calling ClientDocument.startEventDispatcherThread(Runnable) current implementation calls ItsNatDocument.dispatchEventLocally(EventTarget,Event) , otherwise calls ClientDocument.dispatchEvent(EventTargetEventintlong) using document default synchronous mode ( ItsNatDocument.getDefaultSyncMode() ) and AJAX timeout ( ItsNatDocument.getAJAXTimeout() ).

This method is called by the enhanced version of the method org.w3c.dom.events.EventTarget#dispatchEvent(Event) called with the enhanced node returned by ItsNatDocument.getItsNatNode(Node)

The event is routed across the server DOM tree and dispatched to listeners as specified by the W3C DOM Events standard including bubbling and capturing.

This feature is ignored in synchronous AJAX events

When an unfinished AJAX request takes more time than the specified timeout, the request is aborted.

The default value is defined by DocumentTemplate.getAJAXTimeout

If no artifact is found and cascade is true, the method DocumentTemplate.getArtifact(Stringboolean) is called with cascade set to true to continue searching.

This method is symmetric to ServletRequest.getAttribute(String) and ServletContext.getAttribute(String).

The purpose is to provide a document level attribute registry to complement ServletRequest and ServletContext attribute registries.

Is called by ItsNatVariableResolver.getVariable(String) when the variable resolver was created using ItsNatDocument.createItsNatVariableResolver() and does not contain the specified variable name.

This method is symmetric to ServletRequest.getAttributeNames() and ServletContext.getAttributeNames().

The default value is defined by DocumentTemplate.getDefaultDateFormat

The default value is defined by DocumentTemplate.getDefaultNumberFormat

The default value is defined by DocumentTemplate.getDefaultSyncMode

The default value is defined by DocumentTemplate.getEventDispatcherMaxWait

The identity value is unique no other session-identified object in the same session shares the same id.

Although this object is garbage collected, the identity value is never reused by another session-identified object in the same session.

If the specified node is already an ItsNatNode returns self. the wrapper node.

The document is marked as invalid when is unloaded (no more attached to a browser document/page). Non-HTML (XML) documents are automatically invalidated after the XML generation.

If invalid the document is not found anymore on session registry ( ItsNatSession.getItsNatDocumentById(String) ). true if this document is invalid.
See Also:   ItsNatDocument.setInvalid()

The default value is defined by DocumentTemplate.isUsePatternMarkupToRender

This method is symmetric to ServletRequest.removeAttribute(String) and ServletContext.removeAttribute(String).

This method is symmetric to ServletRequest.setAttribute(String,Object) and ServletContext.setAttribute(String,Object).