planetj.dataengine
Class HTMLContext

java.lang.Object
  extended byplanetj.dataengine.AbstractContext
      extended byplanetj.dataengine.HTMLContext
All Implemented Interfaces:
java.lang.Cloneable, IContext, INavigationObject, java.io.Serializable
Direct Known Subclasses:
HTMLOperationContext

public class HTMLContext
extends AbstractContext
implements java.io.Serializable, java.lang.Cloneable

See Also:
Serialized Form

Field Summary
static java.lang.String className
          Class name.
 
Fields inherited from class planetj.dataengine.AbstractContext
DEFAULT_TYPE, PARAM_ESCAPE_NUMBERED, PARAM_ESCAPE_TABLE, PARAM_ESCAPE_USAGE_ID, PARAM_ESCAPE_USER, PARAM_ESCAPE_USER_USAGE_ID, PARAM_NUMBERED, PARAM_TABLE, PARAM_USAGE_ID, PARAM_USER, PARAM_USER_USAGE_ID
 
Constructor Summary
HTMLContext()
          Constructor
HTMLContext(ExecutingContext ec)
          Constructor
HTMLContext(IUser user)
          Deprecated. replaced with HTMLContext(ExecutingContext)
 
Method Summary
 java.lang.Object execute()
          Gets a modified HTML code String with parameters replaced with their set values.
static java.lang.String execute(java.lang.String code, Row parameterRow, ExecutingContext ec)
          Creates a new HTMLContext from the given ExecutingContext and executes the context using the given Row for parameter values.
 PropertyGroupList getPropertyGroups()
          Get all the property groups stored in this context.
 
Methods inherited from class planetj.dataengine.AbstractContext
clear, clearParameterValues, clone, equals, getCode, getCreationSource, getDataTimestamp, getDisplayParameters, getExecutingContext, getFirstDisplayParameter, getFirstParameterForInput, getNavigationKey, getNavigationListKey, getOriginalCode, getParameter, getParameter, getParameterCollection, getParameterCount, getParameterCount, getParameterDisplayFields, getParameterDisplayFields, getParameterRow, getParameters, getParameters, getParameterSource, getParameterValidationExceptions, getParameterValuesType, getPrimaryContext, getPropertyGroup, getPropertyGroups, getRowParameters, isCloneNeeded, isContainsDisplayParameters, isContainsParameters, isLocked, isParameterized, isRefreshing, isSecondaryContext, loadGlobalValues, loadParameterRequestAndSessionValues, loadSQLTextReplacementValues, loadUserAndExecutingContextValues, lock, parameterAltered, removeNavigationKey, setCode, setCode, setCreationSource, setDataTimestamp, setExecutingContext, setNavigationKey, setParameterCollection, setParameterDisplayValues, setParameterValue, setParameterValue, setParameterValues, setParameterValues, setParameterValuesType, setPrimaryContext, setRefreshing, toString
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

className

public static final java.lang.String className
Class name.

Constructor Detail

HTMLContext

public HTMLContext()
Constructor


HTMLContext

public HTMLContext(IUser user)
Deprecated. replaced with HTMLContext(ExecutingContext)

Constructor


HTMLContext

public HTMLContext(ExecutingContext ec)
Constructor

Method Detail

execute

public static java.lang.String execute(java.lang.String code,
                                       Row parameterRow,
                                       ExecutingContext ec)
Creates a new HTMLContext from the given ExecutingContext and executes the context using the given Row for parameter values.


execute

public java.lang.Object execute()
                         throws CMException
Gets a modified HTML code String with parameters replaced with their set values.

Specified by:
execute in class AbstractContext
Throws:
CMException

getPropertyGroups

public PropertyGroupList getPropertyGroups()
Get all the property groups stored in this context.

Specified by:
getPropertyGroups in interface IContext
Specified by:
getPropertyGroups in class AbstractContext