e4s.application.sysmodule
Class E4ModuleWindowSize

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

public class E4ModuleWindowSize
extends E4ModuleImplementation

This module enables to store window dimensions (width, height) in a e4s.util.E4UserValue when the window is resized, and can restore any previous selected window size.

See Also:

A.openInNewWindow(), E4MethodPickup, E4UserValues, E4MethodPickup._PARAM_WINDOWNAME

Field Summary

static java.lang.String	PREFIX_WINDOW_SIZE Prefix value to store window dimensions in e4s.util.E4UserValue
static E4Method	resize Internal Use; Callback function to get the window size as Ajax request.

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

E4ModuleWindowSize()

Method Summary

static java.lang.String	_getSVNVersionString()
static void	addScript(BODY body, E4MethodPickup mref, E4ServletImplementation_Intf servlet) When a window is beeing opened, you should call one of the addScript(..) functions.
static void	addScript(BODY body, java.lang.String windowId, E4ServletImplementation_Intf servlet) When a window is beeing opened, you should call one of the addScript(..) functions.
static void	addScript(FRAMESET frameset, E4MethodPickup mref, E4ServletImplementation_Intf servlet) When a window is beeing opened, you should call one of the addScript(..) functions.
static void	addScript(FRAMESET frameset, java.lang.String windowId, E4ServletImplementation_Intf servlet) When a window is beeing opened, you should call one of the addScript(..) functions.
int	getWindowHeight(java.lang.String windowId, int defHeight) Get any previous stored window dimension.
static int	getWindowHeight(java.lang.String windowId, int defHeight, E4ApplObj_Intf applobj) Get any previous stored window dimension.
int	getWindowWidth(java.lang.String windowId, int defWidth) Get any previous stored window dimension.
static int	getWindowWidth(java.lang.String windowId, int defWidth, E4ApplObj_Intf applobj) Get any previous stored window dimension.
void	resize(HTML html, E4CgiParams params) Internal Use; Callback function to get the window size as Ajax request.

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

resize

public static E4Method resize

Internal Use; Callback function to get the window size as Ajax request.

PREFIX_WINDOW_SIZE

public static final java.lang.String PREFIX_WINDOW_SIZE

Prefix value to store window dimensions in e4s.util.E4UserValue

See Also:

Constant Field Values

Constructor Detail

E4ModuleWindowSize

public E4ModuleWindowSize()

Method Detail

resize

public void resize(HTML html,
                   E4CgiParams params)
            throws java.lang.Exception

Internal Use; Callback function to get the window size as Ajax request.

Throws:

java.lang.Exception

addScript

public static void addScript(FRAMESET frameset,
                             E4MethodPickup mref,
                             E4ServletImplementation_Intf servlet)
                      throws E4DBException

When a window is beeing opened, you should call one of the addScript(..) functions. There will be two scripts added as event handlers: One event handler (@see E4EventHandlerFRAMESET for resize, and one for onload. The resize handler calles the method resize as ajax request to store the dimensions, the onload function uses the dimensions to set the window size using java script method resizeTo(..).

Parameters:

frameset - the frameset where the scripts to be added

mref - a method (use the ID E4MethodPickup.getId()

Throws:

E4DBException

See Also:

addScript(e4s.html.FRAMESET, String, e4s.servlet.E4ServletImplementation_Intf)

addScript

public static void addScript(BODY body,
                             E4MethodPickup mref,
                             E4ServletImplementation_Intf servlet)
                      throws E4DBException

When a window is beeing opened, you should call one of the addScript(..) functions. There will be two scripts added as event handlers: One event handler (@see E4EventHandlerFRAMESET for resize, and one for onload. The resize handler calles the method resize as ajax request to store the dimensions, the onload function uses the dimensions to set the window size using java script method resizeTo(..).

Parameters:

body - the bodywhere the scripts to be added

mref - a method (use the ID E4MethodPickup.getId()

Throws:

E4DBException

See Also:

addScript(e4s.html.BODY, String, e4s.servlet.E4ServletImplementation_Intf)

addScript

public static void addScript(FRAMESET frameset,
                             java.lang.String windowId,
                             E4ServletImplementation_Intf servlet)
                      throws E4DBException

When a window is beeing opened, you should call one of the addScript(..) functions. There will be two scripts added as event handlers: One event handler (@see E4EventHandlerFRAMESET for resize, and one for onload. The resize handler calles the method resize as ajax request to store the dimensions, the onload function uses the dimensions to set the window size using java script method resizeTo(..).

Parameters:

frameset - the frameset where the scripts to be added

windowId - the ID of the opened window

Throws:

E4DBException

See Also:

addScript(e4s.html.BODY, String, e4s.servlet.E4ServletImplementation_Intf)

addScript

public static void addScript(BODY body,
                             java.lang.String windowId,
                             E4ServletImplementation_Intf servlet)
                      throws E4DBException

When a window is beeing opened, you should call one of the addScript(..) functions. There will be two scripts added as event handlers: One event handler (@see E4EventHandlerBODY for resize, and one for onload. The resize handler calles the method resize as ajax request to store the dimensions, the onload function uses the dimensions to set the window size using java script method resizeTo(..).

Parameters:

body - the bodywhere the scripts to be added

windowId - the ID of the opened window

Throws:

E4DBException

See Also:

addScript(e4s.html.FRAMESET, String, e4s.servlet.E4ServletImplementation_Intf)

getWindowHeight

public int getWindowHeight(java.lang.String windowId,
                           int defHeight)
                    throws E4DBException

Get any previous stored window dimension.

Parameters:

windowId - the ID of the window E4MethodPickup._PARAM_WINDOWNAME

defHeight - the default height in pixels for this window

Returns:

the height of the window in pixels

Throws:

E4DBException

See Also:

getWindowWidth(String, int), getWindowHeight(String, int, e4s.application.E4ApplObj_Intf)

getWindowHeight

public static int getWindowHeight(java.lang.String windowId,
                                  int defHeight,
                                  E4ApplObj_Intf applobj)
                           throws E4DBException

Get any previous stored window dimension.

Parameters:

windowId - the ID of the window E4MethodPickup._PARAM_WINDOWNAME

defHeight - the default height in pixels for this window

applobj - a valid application object

Returns:

the height of the window in pixels

Throws:

E4DBException

See Also:

getWindowHeight(String, int), getWindowWidth(String, int, e4s.application.E4ApplObj_Intf)

getWindowWidth

public int getWindowWidth(java.lang.String windowId,
                          int defWidth)
                   throws E4DBException

Get any previous stored window dimension.

Parameters:

windowId - the ID of the window E4MethodPickup._PARAM_WINDOWNAME

defWidth - the default width in pixels for this window

Returns:

the width of the window in pixels

Throws:

E4DBException

See Also:

getWindowHeight(String, int), getWindowWidth(String, int, e4s.application.E4ApplObj_Intf)

getWindowWidth

public static int getWindowWidth(java.lang.String windowId,
                                 int defWidth,
                                 E4ApplObj_Intf applobj)
                          throws E4DBException

Get any previous stored window dimension.

Parameters:

windowId - the ID of the window E4MethodPickup._PARAM_WINDOWNAME

defWidth - the default width in pixels for this window

applobj - a valid application object

Returns:

the width of the window in pixels

Throws:

E4DBException

See Also:

getWindowHeight(String, int), getWindowWidth(String, int, e4s.application.E4ApplObj_Intf)

_getSVNVersionString

public static java.lang.String _getSVNVersionString()