e4s.application.sysmodule
Class E4ModuleTreeHandling

java.lang.Object
  e4s.util.E4Object
      e4s.html.E4HtmlObject
          e4s.servlet.E4ModuleImplementation
              e4s.application.sysmodule.E4ModuleTreeHandling

public class E4ModuleTreeHandling
extends E4ModuleImplementation

This class provides default tree handling (opening nodes, activating nodes). See also E4TreeNode and E4TreeNode_Intf

Since:

JDK 1.4

Field Summary

static java.lang.String	_PARAM_ACTION Parameter used to define the current node id.
static java.lang.String	_PARAM_ALIAS Parameter used to define method reflection alias key.
static java.lang.String	_PARAM_NODE_ID Parameter used to define the current node id.
static java.lang.String	_PARAM_TARGET Parameter used to define the target frame.
static java.lang.String	_PARAM_TEXT Parameter used to define the displayed text.
static java.lang.String	_PARAM_TREE_OBJ Parameter used to define the tree object.
static java.lang.String	ACTION_ACTIVATE
static java.lang.String	ACTION_TOGGLE
static E4Method	activateNode Defines the method for activating (selecting) a node.
static E4Method	toggleNode Defines the method for toggling a node, means open and close a node.

Fields inherited from class e4s.html.E4HtmlObject

m_parent_e4sID

Fields inherited from class e4s.util.E4Object

CRLF, E4S_CORE_SYSTEM_LANGUAGE, NBSP, NULLSTR, URL_ENCODING_CHARSET

Constructor Summary

E4ModuleTreeHandling()

Method Summary

static java.lang.String	_getSVNVersionString()
void	activateNode(HTML html, E4CgiParams params) Change the activate (selected) state of a tree node as well as of all other nodes.
static E4TreeNode_Intf	findNode(E4CgiParams params, E4ServletImplementation_Intf servlet) Find a Node based on parameters and a session persistance entity of an E4TreeElement,
static E4TreeElement	findTree(E4CgiParams params, E4ServletImplementation_Intf servlet) Find a Node based on parameters and a session persistance entity of an E4TreeElement,
static E4TreeNode_Intf	getElement(E4CgiParams params, E4ServletImplementation_Intf servlet) Deprecated.
static E4TreeElement	handleActivateEvent(E4CgiParams params, E4ServletImplementation_Intf servlet)
static void	handleActivateEvent(E4CgiParams params, E4Tree treeNav)
static E4TreeElement	handleToggleEvent(E4CgiParams params, E4ServletImplementation_Intf servlet)
static void	handleToggleEvent(E4CgiParams params, E4Tree treeNav)
static E4TreeElement	handleTreeEvents(E4CgiParams params, E4ServletImplementation_Intf servlet)
static void	handleTreeEvents(E4CgiParams params, E4Tree treeNav)
void	toggleNode(HTML html, E4CgiParams params) Change the open (display) mode of a tree node (E4TreeNode_Intf).

Methods inherited from class e4s.servlet.E4ModuleImplementation

canDo, canDo, canRun, closeHtmlOutput, empty2nbsp, empty2nbsp, getApplication_Permissions, getApplication, getApplObj, getClient, getClientImage, getClientObject, getClientObject, getClientObject, getClientValue, getClientValueBool, getClientValueDate, getClientValueFloat, getClientValueInt, getClientValueLong, getCookie, getCookieArr, getCookieBool, getCookieDate, getCookieLong, getCountryCode, getCSS, getDateFormat, getDbConnection, getDecimalSign, getE4ClientLogo, getE4S_Permissions, getLanguage_App, getLanguage_Sys, getLanguage, getParameters, getPersistantParameter, getPersistantParameterBoolean, getPersistantParameterDate, getPersistantParameterInt, getPersistantParameterIntArr, getPersistantParameterLong, getPickParams, getRemoteAddr, getRequiredModulePermission, getServlet, getSession, getSessionId, getSessionObject_Boolean, getSessionObject_Long, getSessionObject_String, getSessionObject, getSessionObject, getSessionObjects, getTimeFormat, getTimeZone, getUrl, getUserEmail, getUserValue, getUserValue, getUserValueArr, getUserValueBool, getUserValueBool, getUserValueDate, getUserValueDate, getUserValueInt, getUserValueInt, getUserValueLong, getUserValueLong, isok, isPersistant, isRunningWindow, isTimeout, ok, openHtmlOutput, removeApplicationObject, removeClientObject, removeClientObject, removeClientObject, removeClientValue, removeSessionObject, removeSessionObject, removeUserValue, removeUserValue, resetClientLogo, setAjaxTrace, setApplication, setApplicationObject, setClientObject, setClientObject, setClientObject, setClientValue, setClientValue, setClientValue, setClientValue, setClientValue, setClientValue, setClientValue, setCookie, setCookie, setCookie, setCookie, setCookie, setCookie, setCookie, setCookie, setPersistantParameter, setPersistantParameter, setPersistantParameter, setPersistantParameter, setPersistantParameter, setPersistantParameter, setServlet, setSessionObject, setSessionObject, setSessionObject, setSessionObject, setUserValue, setUserValue, setUserValue, setUserValue, setUserValue, setUserValue, setUserValue, setUserValue, setUserValue, setUserValue, setUserValue, setUserValue, setUserValue, setUserValue, setUserValue, SystemError, write, write, write, write, write, writeln, writeln, writeln, writeln

Methods inherited from class e4s.html.E4HtmlObject

E4ID, E4ID, set_e4sID

Methods inherited from class e4s.util.E4Object

Calendar, CName, CName, E4LabelApp, E4LabelApp, E4LabelApp, E4LabelApp, E4LabelApp, E4LabelApp, E4LabelNone, E4LabelNone, E4LabelNone, E4LabelNone, E4LabelSys, E4LabelSys, e4sCopyright, e4sVersion, encode, encode, encode, encodeHtml, encodeHtml, encodeHtml, encodeURL, encodeURL, encodeURL, finalize, getLINE, getTRACE, getTRACE, getTRACE, getTRACE, getTRACE, getTRACE, getTraceMemory, HtmlEncode, HtmlEncode, HtmlEncode, isdecimal, isdigit, isnotok, isnotok, isnumeric, isok, isok, isok, lastCallingFunction, lastCallingFunction, lastCallingFunction, lastCallingFunction, lastCallingStack, mkdirs, null2nbsp, null2nbsp, null2nbsp, ok, ok, ok, outPrintln, setLogFile4Trace, setTraceMemory, STACKTRACE, toDebug, toDouble, toFloat, toFloat, toString, TRACE_CALLS, TRACE, TRACE, TRACE, TRACE, TRACE, TRACE, TRACE, TRACE, TRACE, TRACE, TRACE, TRACE, wait

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

toggleNode

public static E4Method toggleNode

Defines the method for toggling a node, means open and close a node.

See Also:

toggleNode(HTML html, E4CgiParams p)

activateNode

public static E4Method activateNode

Defines the method for activating (selecting) a node.

See Also:

activateNode(HTML html, E4CgiParams p)

_PARAM_TREE_OBJ

public static final java.lang.String _PARAM_TREE_OBJ

Parameter used to define the tree object.

See Also:

e4s.html.tree.E4Tree#getTreeNavigation, Constant Field Values

_PARAM_NODE_ID

public static final java.lang.String _PARAM_NODE_ID

Parameter used to define the current node id.

See Also:

Constant Field Values

_PARAM_ACTION

public static final java.lang.String _PARAM_ACTION

Parameter used to define the current node id.

See Also:

Constant Field Values

ACTION_ACTIVATE

public static final java.lang.String ACTION_ACTIVATE

See Also:

Constant Field Values

ACTION_TOGGLE

public static final java.lang.String ACTION_TOGGLE

See Also:

Constant Field Values

_PARAM_TARGET

public static final java.lang.String _PARAM_TARGET

Parameter used to define the target frame.

See Also:

Constant Field Values

_PARAM_TEXT

public static final java.lang.String _PARAM_TEXT

Parameter used to define the displayed text.

See Also:

Constant Field Values

_PARAM_ALIAS

public static final java.lang.String _PARAM_ALIAS

Parameter used to define method reflection alias key.

See Also:

E4Method, Constant Field Values

Constructor Detail

E4ModuleTreeHandling

public E4ModuleTreeHandling()

Method Detail

toggleNode

public void toggleNode(HTML html,
                       E4CgiParams params)

Change the open (display) mode of a tree node (E4TreeNode_Intf). If a user clicks on the [+] or [-] symbol beside a tree node, this changes the E4TreeNode_Intf.isOpen() state of the node. The whole tree needs to be stored in the session objects (see E4ServletImplementation_Intf.getSessionObject(String)). Parameters used to handle tree functionality: the tree-object handle _PARAM_TREE_OBJ and the node-id (_PARAM_NODE_ID) as well as the target frame (_PARAM_TARGET).

Parameters:

html - the active HTML context to be used for output.

params - parameters, including the tree-object handle, node-id and target frame.

See Also:

activateNode

activateNode

public void activateNode(HTML html,
                         E4CgiParams params)

Change the activate (selected) state of a tree node as well as of all other nodes. (See E4TreeNode_Intf). If a user clicks on the node text or associated images, this changes the E4TreeNode_Intf.isActive() state of the selected node to true but all other nodes to false. The whole tree needs to be stored in the session objects (see E4ServletImplementation_Intf.getSessionObject(String)).

Parameters:

html - the active HTML context to be used for output.

params - parameters, including the tree-object handle _PARAM_TREE_OBJ and the node-id (_PARAM_NODE_ID) as well as the target frame (_PARAM_TARGET).

See Also:

toggleNode

handleTreeEvents

public static E4TreeElement handleTreeEvents(E4CgiParams params,
                                             E4ServletImplementation_Intf servlet)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

handleTreeEvents

public static void handleTreeEvents(E4CgiParams params,
                                    E4Tree treeNav)
                             throws java.lang.Exception

Throws:

java.lang.Exception

handleActivateEvent

public static E4TreeElement handleActivateEvent(E4CgiParams params,
                                                E4ServletImplementation_Intf servlet)
                                         throws java.lang.Exception

Throws:

java.lang.Exception

handleActivateEvent

public static void handleActivateEvent(E4CgiParams params,
                                       E4Tree treeNav)
                                throws java.lang.Exception

Throws:

java.lang.Exception

getElement

public static E4TreeNode_Intf getElement(E4CgiParams params,
                                         E4ServletImplementation_Intf servlet)
                                  throws java.lang.Exception

Deprecated.

Throws:

java.lang.Exception

See Also:

findNode(e4s.html.E4CgiParams, e4s.servlet.E4ServletImplementation_Intf)

findNode

public static E4TreeNode_Intf findNode(E4CgiParams params,
                                       E4ServletImplementation_Intf servlet)
                                throws java.lang.Exception

Find a Node based on parameters and a session persistance entity of an E4TreeElement,

Parameters:

params - the parameters, must contain _PARAM_TREE_OBJ and _PARAM_NODE_ID

servlet - the current servlet context

Returns:

a tree node interface

Throws:

java.lang.Exception - if the tree object cannot be found or if the node within that tree cannot be found

findTree

public static E4TreeElement findTree(E4CgiParams params,
                                     E4ServletImplementation_Intf servlet)
                              throws java.lang.Exception

Find a Node based on parameters and a session persistance entity of an E4TreeElement,

Parameters:

params - the parameters, must contain _PARAM_TREE_OBJ and _PARAM_NODE_ID

servlet - the current servlet context

Returns:

a tree node interface

Throws:

java.lang.Exception - if the tree object cannot be found or if the node within that tree cannot be found

handleToggleEvent

public static E4TreeElement handleToggleEvent(E4CgiParams params,
                                              E4ServletImplementation_Intf servlet)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

handleToggleEvent

public static void handleToggleEvent(E4CgiParams params,
                                     E4Tree treeNav)
                              throws java.lang.Exception

Throws:

java.lang.Exception

_getSVNVersionString

public static java.lang.String _getSVNVersionString()