se.entra.phantom.server.http

Class HtmlVariable

java.lang.Object

se.entra.phantom.server.http.HtmlVariable

All Implemented Interfaces:

NetPhantomConstants, HtmlTag

public class HtmlVariable
extends Object
implements HtmlTag, NetPhantomConstants

Handles data for an HTML variable in order to perform variable substitution, etc, faster.

Author:

Christopher Mindus

Field Summary

Fields

Modifier and Type	Field and Description
HtmlParser	parser The parser.

Fields inherited from interface se.entra.phantom.common.NetPhantomConstants

ACTION_CLOSEWINDOW, ACTION_CONTROL, ACTION_HOSTKEY, ACTION_MENU, ACTION_NONE, ACTION_NOTEBOOKPAGE, ACTION_POPUPMENU, CC_BACKGROUND, CC_BOTH, CC_FOREGROUND, CC_NONE, CLIPBOARD_GET, CLIPBOARD_SET, DATEF_DMY, DATEF_MDY, DATEF_SYSTEM, DATEF_YMD, DDE_ADVISE, DDE_EXECUTE, DDE_INITIATE, DDE_POKE, DDE_REQUEST, DDE_TERMINATE, DDE_UNADVISE, DDE_UPDATE, DDEVAR_DISABLE, DDEVAR_ENABLE, DDEVAR_REQUEST, DDEVAR_SET, DDEVAR_VALIDATE, EFT_AMOUNT, EFT_DATE, EFT_DATEAMOUNT, EFT_NORMAL, EFT_PASSWORD, EVENT_CHAR, EVENT_CHECK, EVENT_CLICK, EVENT_COMMAND, EVENT_DBLCLICK, EVENT_DDECONNECTION, EVENT_DDEDATA, EVENT_DDEERROR, EVENT_DDEEXECUTE, EVENT_DDEINVALIDATE, EVENT_DDEPOKE, EVENT_DDEREQUEST, EVENT_DEFOCUS, EVENT_FOCUS, EVENT_PAGEDOWN, EVENT_PAGEUP, EVENT_SELECT, EVENT_UNKNOWN, EVENT_USERCHANGE, EXTENDEDINFO_IDS_TO_CLIENT, FOCUSTYPE_CLIENTTARGET, FOCUSTYPE_CONTROL, FOCUSTYPE_NONE, ICON_CRITICAL, ICON_INFORMATION, ICON_NOICON, ICON_QUERY, ICON_WARNING, J_AUTO, J_BOTTOM, J_BOTTOMLEFT, J_BOTTOMRIGHT, J_CENTER, J_LEFT, J_RIGHT, J_TOP, J_TOPLEFT, J_TOPRIGHT, MAX_PANELS_PER_SESSION, MAX_SESSIONS, MB_ABORTRETRYIGNORE, MB_CANCEL, MB_ENTER, MB_ENTERCANCEL, MB_OK, MB_OKCANCEL, MB_RETRYCANCEL, MB_YESNO, MB_YESNOCANCEL, MBID_CANCEL, MBID_DEFAULT, MBID_ENTER, MBID_IGNORE, MBID_NO, MBID_OK, MBID_RETRY, MBID_YES, MS_MOVE, MS_NONE, MS_SIZE, NETPHANTOM_COPYRIGHT, NETPHANTOM_COPYRIGHT2, NETPHANTOM_VERSION, OBJEVENT_CHECK, OBJEVENT_CLICK, OBJEVENT_DBLCLICK, OBJEVENT_DEFOCUS, OBJEVENT_FOCUS, OBJEVENT_SELECT, OBJEVENT_USERCHANGE, PANELCREATE_APPPANEL, PANELCREATE_DANGLINGPANEL, PANELCREATE_DLGFRAME, PANELCREATE_EXTENDEDINFO, PANELCREATE_ICON, PANELCREATE_INDIVIDUALSIZE, PANELCREATE_POPUP, REPLYTYPE_CLIENTEXECUTE, REPLYTYPE_CLIPBOARD, REPLYTYPE_DDE, REPLYTYPE_FFONTLIST, REPLYTYPE_MESSAGEBOX, REPLYTYPE_REPORT, REPLYTYPE_SAVEPROPS, REPLYTYPE_TERMMARK, RPRT_CANCELPRINTJOB, RPRT_CLOSEPRINTJOB, RPRT_CONTPRINTJOB, RPRT_OPENPRINTJOB, RPRT_PRINTJOBCANCLD, RPRT_PRINTJOBCLOSED, RPRT_PRINTJOBCONT, RPRT_PRINTJOBOPENED, RPRT_PRINTJOBSTARTED, RPRT_STARTPRINTJOB, SELMODE_NORMAL, SELMODE_NOTALLOWED, SELMODE_REQUIRED, SELTYPE_MULTIPLE, SELTYPE_SINGLE, SEPARATOR, SEPARATORCHAR, TRANS_APPLICATIONCHANGE, TRANS_CALLOBJECT, TRANS_CANCELEXIT, TRANS_CLEARLOCK, TRANS_CLIENTEXECUTE, TRANS_CLIENTJARS, TRANS_CLIENTTEXTTABLE, TRANS_CLIENTUPDATED, TRANS_CLIENTUPDATEDNOLOCK, TRANS_CLIPBOARD, TRANS_CLIPBOARDCOMPONENT, TRANS_CLOSETERMINALWINDOW, TRANS_CONNECTIONREFUSED, TRANS_COUNTRYINFO, TRANS_CREATEPANEL, TRANS_CREATESESSION, TRANS_DDE, TRANS_DDEEVENT, TRANS_DDEEVENTREPLY, TRANS_DDEVAREVENT, TRANS_DISPLAYHELP, TRANS_DISPLAYTERMINAL, TRANS_DISPLAYTOOLTIPS, TRANS_ENDCONVERSATION, TRANS_EXIT, TRANS_FONTSUBSTITUTION, TRANS_HOSTCOLORTABLE, TRANS_HOSTPRINT, TRANS_HWND, TRANS_INACTIVESESSION, TRANS_INITIATE, TRANS_KEEPALIVE, TRANS_LOCALE, TRANS_LOGEVENT, TRANS_MESSAGEBOX, TRANS_MESSAGEBOXWITHREPLY, TRANS_MODALREPLY, TRANS_MULTTERM, TRANS_PING, TRANS_PRINTCOMPONENT, TRANS_PRINTPANEL, TRANS_PRINTREPORT, TRANS_PRTWINKEY, TRANS_RECONNECT, TRANS_REDIRECTION, TRANS_REMOVEPANELATLEVEL, TRANS_REMOVETERMINAL, TRANS_RENEGOTIATESSL, TRANS_REQUESTHELP, TRANS_RESOURCEURL, TRANS_SELECTSESSION, TRANS_SESSIONACTIVE, TRANS_SESSIONSELECTED, TRANS_SETCOLORS, TRANS_SETFOCUS, TRANS_SETLOCK, TRANS_SETPANELNESTLEVEL, TRANS_SETUPPARAMS, TRANS_SHOWDOCUMENT, TRANS_SOCKET, TRANS_SOUNDALARM, TRANS_STARTUPINFO, TRANS_STOPSESSION, TRANS_TERMINALDATA, TRANS_TERMINALUPDATE, TRANS_TERMINALWINDOW, TRANS_TERMWINTEXT, TRANS_UPDATEAPPLICATION, TRANS_UPDATEPANEL, TRANS_USEREXITPRTKEY, TRANSACTION_VERSION, TS_CLOSE, TS_DATA, TS_ERROR, TS_OPEN, VSIGN_MINUS, VSIGN_NONE, VSIGN_PLUSMINUS, YEARF_6DIG, YEARF_8DIG, YEARF_EXP8

Constructor Summary

Constructors

Constructor and Description
HtmlVariable(HtmlParser parser, String rawData, String name, int index) Creates the variable.

Method Summary

Modifier and Type	Method and Description
static boolean	containsNetPhantomVariable(ClientSession clientSession, String s) Checks if a string contains a valid NetPhantom variable.
static boolean	containsNetPhantomVariable(HttpSession session, String s) Checks if a string contains a valid NetPhantom variable.
String	getData(HttpSession httpSession) Gets the data of the variable.
static String	getData(HttpSession httpSession, HttpResource resource, String name, int index) Gets the data of the variable.
static String	getData(HttpSession httpSession, HttpResource resource, String name, int index, boolean doScriptEncode) Gets the data of the variable.
static String	getQuotedTextData(HttpSession session, HtmlResource resource, String text) Returns a string that is variable-substituted if inside a quote, strings such as @variable@ is encountered.
static String	getQuotedTextData(HttpSession session, HtmlResource resource, String text, boolean doScriptEncode) Returns a string that is variable-substituted if inside a quote, strings such as @variable@ is encountered.
int	getRawSize() Gets the raw size of the element (the original text in the HTML document).
static String	getTextData(HttpSession session, HttpResource resource, String text) Returns a string that is variable-substituted (strings such as @variable@ is encountered).
static int	isNetPhantomVariable(ClientSession clientSession, String name) Checks if a string could be a valid NetPhantom variable.
String	toString() Returns the debug string representation.

Methods inherited from class java.lang.Object

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

Field Detail

parser

public final HtmlParser parser

The parser.

Constructor Detail

HtmlVariable

public HtmlVariable(HtmlParser parser,
                    String rawData,
                    String name,
                    int index)

Creates the variable.

Method Detail

getRawSize

public int getRawSize()

Gets the raw size of the element (the original text in the HTML document).

Specified by:

getRawSize in interface HtmlTag

containsNetPhantomVariable

public static boolean containsNetPhantomVariable(HttpSession session,
                                                 String s)

Checks if a string contains a valid NetPhantom variable. The variable "session" may be null.

containsNetPhantomVariable

public static boolean containsNetPhantomVariable(ClientSession clientSession,
                                                 String s)

Checks if a string contains a valid NetPhantom variable. The variable "clientSession" may be null.

isNetPhantomVariable

public static int isNetPhantomVariable(ClientSession clientSession,
                                       String name)

Checks if a string could be a valid NetPhantom variable.

Returns:

-1 if it's not.

getData

public String getData(HttpSession httpSession)

Gets the data of the variable.

The parameter clientSession is null if the document is not (yet) tied to a NetPhantom Application.

Specified by:

getData in interface HtmlTag

getData

public static String getData(HttpSession httpSession,
                             HttpResource resource,
                             String name,
                             int index)

Gets the data of the variable.

The parameter clientSession is null if the document is not (yet) tied to a NetPhantom Application.

getData

public static String getData(HttpSession httpSession,
                             HttpResource resource,
                             String name,
                             int index,
                             boolean doScriptEncode)

Gets the data of the variable.

The parameter clientSession is null if the document is not (yet) tied to a NetPhantom Application.

toString

public String toString()

Returns the debug string representation.

Overrides:

toString in class Object

getQuotedTextData

public static String getQuotedTextData(HttpSession session,
                                       HtmlResource resource,
                                       String text)

Returns a string that is variable-substituted if inside a quote, strings such as @variable@ is encountered.

getQuotedTextData

public static String getQuotedTextData(HttpSession session,
                                       HtmlResource resource,
                                       String text,
                                       boolean doScriptEncode)

Returns a string that is variable-substituted if inside a quote, strings such as @variable@ is encountered.

getTextData

public static String getTextData(HttpSession session,
                                 HttpResource resource,
                                 String text)

Returns a string that is variable-substituted (strings such as @variable@ is encountered).