com.HybridServerPages
Class BasePage

java.lang.Object
  extended by com.HybridServerPages.BasePage

public class BasePage
extends java.lang.Object

Derive page state classes ("*_PS.java") from this class


Field Summary
protected  javax.servlet.http.HttpServletRequest request
           
protected  javax.servlet.http.HttpSession session
           
 
Constructor Summary
BasePage()
           
 
Method Summary
protected  boolean $a()
          Do not touch
protected  void $accept(int code, java.lang.String msg, java.lang.Object more, BaseComponent source)
          Override this method to get signals from sub-components.
protected  void $ajax(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Override this method to process Ajax request at the page level
protected  int[] $DR()
          Do not touch
protected  int $get_$DR2(int index)
          Do not touch
protected  int $get_$SH2(int index)
          Do not touch
protected  int $get_$SI2(int index)
          Do not touch
protected  int $get_$SL2(int index)
          Do not touch
protected  int $get_$SR2(int index)
          Do not touch
protected  BaseApplication $getAS()
          Access to Application State instance
protected  java.lang.String $getPageId()
          Do not touch
protected  java.lang.String $getParam(java.lang.String name, java.lang.String previous_value)
          Access to page-related HTTP request parameters
protected  void $handle(java.lang.String h1, java.lang.String h2)
          Override this method to process HTTP request
protected  int[] $I()
          Do not touch
protected  boolean $isLoaded()
          Do not touch
protected  int[] $R()
          Do not touch
protected  void $render(java.io.PrintWriter $)
          Do not touch
protected  void $set_$DR2(int[] arg)
          Do not touch
protected  void $set_$SH2(int[] arg)
          Do not touch
protected  void $set_$SI2(int[] arg)
          Do not touch
protected  void $set_$SL2(int[] arg)
          Do not touch
protected  void $set_$SR2(int[] arg)
          Do not touch
protected  void $setBadParam(java.lang.String name, java.lang.String msg)
          Marks the parameter as bad
protected  void $setLoaded()
          Do not touch
protected  boolean $setNextPage(java.lang.String pn)
          Sets the next page to be shown.
protected  void $setReturn()
          This is for support of the back button
protected  int[] $SH()
          Do not touch
protected  int[] $SI()
          Do not touch
protected  int[] $SL()
          Do not touch
protected  int[] $SR()
          Do not touch
protected  java.lang.String badParam(java.lang.String name, java.lang.String id)
          returns message if the parameter did not pass validation
protected  BaseComponent getComponent(java.lang.String id)
          Access to current component from widget, call it as getComponent($#)
protected  java.lang.String getPageName()
          Returns fully qualified name of the currently processed page presentation class
protected  java.lang.String getShortPageName()
          Returns the short name of the current page
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

request

protected javax.servlet.http.HttpServletRequest request

session

protected javax.servlet.http.HttpSession session
Constructor Detail

BasePage

public BasePage()
Method Detail

$getPageId

protected java.lang.String $getPageId()
Do not touch


$R

protected int[] $R()
Do not touch


$I

protected int[] $I()
Do not touch


$SI

protected int[] $SI()
Do not touch


$SL

protected int[] $SL()
Do not touch


$SR

protected int[] $SR()
Do not touch


$DR

protected int[] $DR()
Do not touch


$SH

protected int[] $SH()
Do not touch


$set_$SI2

protected void $set_$SI2(int[] arg)
Do not touch


$set_$SL2

protected void $set_$SL2(int[] arg)
Do not touch


$set_$SR2

protected void $set_$SR2(int[] arg)
Do not touch


$set_$DR2

protected void $set_$DR2(int[] arg)
Do not touch


$set_$SH2

protected void $set_$SH2(int[] arg)
Do not touch


$get_$SI2

protected int $get_$SI2(int index)
Do not touch


$get_$SL2

protected int $get_$SL2(int index)
Do not touch


$get_$SR2

protected int $get_$SR2(int index)
Do not touch


$get_$DR2

protected int $get_$DR2(int index)
Do not touch


$get_$SH2

protected int $get_$SH2(int index)
Do not touch


$isLoaded

protected boolean $isLoaded()
Do not touch


$setLoaded

protected void $setLoaded()
Do not touch


$render

protected void $render(java.io.PrintWriter $)
Do not touch


$a

protected boolean $a()
Do not touch


$ajax

protected void $ajax(javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response)
Override this method to process Ajax request at the page level

Parameters:
request - standard
response - standard

$accept

protected void $accept(int code,
                       java.lang.String msg,
                       java.lang.Object more,
                       BaseComponent source)
Override this method to get signals from sub-components. Otherwise the signal will be propagated up

Parameters:
code - some value
msg - some message
more - some additional data
source - the component that fired the signal

$handle

protected void $handle(java.lang.String h1,
                       java.lang.String h2)
Override this method to process HTTP request

Parameters:
h1 - first (name) part (before ':') of HJ_Action HTTP parameter
h2 - second (value) part of HJ_Action HTTP parameter Note: Using the HJ_Action is optional as HTTP request is always available

$getAS

protected final BaseApplication $getAS()
Access to Application State instance

Returns:
Application State instance if you've provided AS.java class

getPageName

protected java.lang.String getPageName()
Returns fully qualified name of the currently processed page presentation class

Returns:
fully qualified name of the currently processed page presentation class

getShortPageName

protected java.lang.String getShortPageName()
Returns the short name of the current page

Returns:
short name of the current page

$setReturn

protected final void $setReturn()
This is for support of the back button


badParam

protected final java.lang.String badParam(java.lang.String name,
                                          java.lang.String id)
returns message if the parameter did not pass validation

Parameters:
name - of the parameter
id - id of component
Returns:
msg message to be shown at the control

$setBadParam

protected final void $setBadParam(java.lang.String name,
                                  java.lang.String msg)
Marks the parameter as bad

Parameters:
name - of the parameter that did not pass validation
msg - message to be shown at the control

$getParam

protected final java.lang.String $getParam(java.lang.String name,
                                           java.lang.String previous_value)
Access to page-related HTTP request parameters

Parameters:
name - component-scope name of the parameter
previous_value - returned if no such parameter in the current HTTP request. null is OK
Returns:
parameter value.

getComponent

protected final BaseComponent getComponent(java.lang.String id)
Access to current component from widget, call it as getComponent($#)

Parameters:
id - id of the component
Returns:
Instance of the component; null for page

$setNextPage

protected final boolean $setNextPage(java.lang.String pn)
Sets the next page to be shown. If called more than once the last call is effective

Parameters:
pn - name of the page a.k.a. full class name of the page
Returns:
false for all calls except the first one