|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.servlet.jsp.PageContext
railo.runtime.PageContext
public abstract class PageContext
page context for every page object. the PageContext is a jsp page context expanded by CFML functionality. for example you have the method getSession to get jsp combatible session object (HTTPSession) and with sessionScope() you get CFML combatible session object (Struct,Scope).
Field Summary |
---|
Fields inherited from class javax.servlet.jsp.PageContext |
---|
APPLICATION, APPLICATION_SCOPE, CONFIG, EXCEPTION, OUT, PAGE, PAGE_SCOPE, PAGECONTEXT, REQUEST, REQUEST_SCOPE, RESPONSE, SESSION, SESSION_SCOPE |
Constructor Summary | |
---|---|
PageContext()
|
Method Summary | |
---|---|
abstract void |
addPageSource(PageSource ps,
boolean alsoInclude)
adds a PageSource |
abstract Application |
applicationScope()
|
abstract Argument |
argumentsScope()
|
abstract Argument |
argumentsScope(boolean bind)
return the argument scope |
abstract CGI |
cgiScope()
|
abstract void |
clear()
clear the actuell output buffer |
abstract void |
clearCatch()
clear all catches |
abstract void |
clearRemoteUser()
clear the remote user |
abstract Client |
clientScope()
|
abstract Client |
clientScopeEL()
|
abstract void |
close()
Close the response stream. |
abstract Cluster |
clusterScope()
|
abstract Cluster |
clusterScope(boolean create)
cluster scope |
abstract void |
compile(PageSource pageSource)
compile a CFML Template |
abstract void |
compile(String templatePath)
Deprecated. use instead compile(PageSource pageSource) |
abstract Cookie |
cookieScope()
|
abstract void |
doInclude(PageSource source)
Deprecated. use other doInclude methods |
abstract void |
doInclude(PageSource[] source,
boolean runOnce)
includes a path from a absolute path |
abstract void |
doInclude(String source)
includes a path from a absolute path |
abstract void |
doInclude(String source,
boolean runOnce)
includes a path from a absolute path |
abstract Object |
evaluate(String expression)
evaluate given expression |
abstract void |
execute(String realPath,
boolean throwException)
execute a request n the pageConext |
abstract void |
executeRest(String realPath,
boolean throwException)
|
abstract void |
exeLogEnd(int position,
String id)
|
abstract void |
exeLogStart(int position,
String id)
|
abstract void |
flush()
Flush Content of buffer to the response stream of the Socket. |
abstract void |
forceWrite(String str)
Writes a String to the Response Buffer,also when cfoutputonly is true and execution is outside of a cfoutput |
abstract Form |
formScope()
|
abstract Object |
get(Object coll,
Collection.Key key)
|
abstract Object |
get(Object coll,
Collection.Key key,
Object defaultValue)
|
abstract Object |
get(Object coll,
String key)
Deprecated. use instead
|
abstract Object |
get(Object coll,
String key,
Object defaultValue)
Deprecated. use instead
|
abstract Component |
getActiveComponent()
|
abstract UDF |
getActiveUDF()
|
abstract ApplicationContext |
getApplicationContext()
|
abstract PageSource |
getBasePageSource()
|
abstract PageException |
getCatch()
|
abstract String |
getCFID()
|
abstract CFMLFactory |
getCFMLFactory()
|
abstract String |
getCFToken()
|
abstract Object |
getCollection(Object coll,
Collection.Key key)
same like getProperty but return a collection object (QueryColumn) if return object is a Query |
abstract Object |
getCollection(Object coll,
Collection.Key key,
Object defaultValue)
same like getProperty but return a collection object (QueryColumn) if return object is a Query |
abstract Object |
getCollection(Object coll,
String key)
Deprecated. use instead
|
abstract Object |
getCollection(Object coll,
String key,
Object defaultValue)
Deprecated. use instead
|
abstract ConfigWeb |
getConfig()
|
abstract int |
getCurrentLevel()
returns the current level, how deep is the page stack |
abstract PageSource |
getCurrentPageSource()
|
abstract javax.servlet.jsp.tagext.Tag |
getCurrentTag()
returns the tag that is in use |
abstract PageSource |
getCurrentTemplatePageSource()
|
abstract DataSourceManager |
getDataSourceManager()
|
abstract Debugger |
getDebugger()
return debugger of the page Context |
abstract int |
getExecutionTime()
|
abstract FTPPool |
getFTPPool()
|
abstract Object |
getFunction(Object coll,
Collection.Key key,
Object[] args)
call a UDF Function and return "return value" of the function |
abstract Object |
getFunction(Object coll,
String key,
Object[] args)
call a UDF Function and return "return value" of the function |
abstract Object |
getFunctionWithNamedValues(Object coll,
Collection.Key key,
Object[] args)
call a UDF Function and return "return value" of the function |
abstract Object |
getFunctionWithNamedValues(Object coll,
String key,
Object[] args)
call a UDF Function and return "return value" of the function |
abstract javax.servlet.http.HttpServletRequest |
getHttpServletRequest()
return HttpServletRequest, getRequest only returns ServletRequest |
abstract javax.servlet.http.HttpServletResponse |
getHttpServletResponse()
return HttpServletResponse, getResponse only returns ServletResponse |
abstract int |
getId()
|
abstract Iterator |
getIterator(String key)
get variable from string definition and cast it to a Iterator Object |
abstract String |
getJSessionId()
|
abstract Locale |
getLocale()
|
abstract PageContext |
getParentPageContext()
|
abstract boolean |
getPsq()
returns if single quotes will be preserved inside a query tag (psq=preserve single quote) |
abstract Query |
getQuery(Object value)
|
abstract Query |
getQuery(String key)
get variable from string definition and cast it to a Query Object |
abstract QueryCache |
getQueryCache()
|
abstract Reference |
getReference(Object coll,
Collection.Key key)
|
abstract Reference |
getReference(Object coll,
String key)
Deprecated. use instead
|
abstract Credential |
getRemoteUser()
|
abstract long |
getRequestTimeout()
|
abstract OutputStream |
getResponseStream()
|
abstract Resource |
getRootTemplateDirectory()
|
abstract javax.servlet.jsp.JspWriter |
getRootWriter()
|
abstract short |
getSessionType()
|
abstract long |
getStartTime()
|
abstract Array |
getTemplatePath()
array of current template stack |
abstract Thread |
getThread()
|
abstract Threads |
getThreadScope(Collection.Key name)
|
abstract Threads |
getThreadScope(String name)
Deprecated. use instead setThreadScope(Collection.Key name,Threads t) |
abstract String[] |
getThreadScopeNames()
|
abstract TimeZone |
getTimeZone()
|
abstract String |
getURLToken()
|
abstract Object |
getVariable(String var)
|
abstract VariableUtil |
getVariableUtil()
|
abstract void |
handlePageException(PageException pe)
specialised method for handlePageException with argument Exception or Throwable |
abstract boolean |
hasFamily()
|
abstract void |
initBody(javax.servlet.jsp.tagext.BodyTag bodyTag,
int state)
init body of a tag |
abstract boolean |
isCFCRequest()
|
abstract Component |
loadComponent(String compPath)
|
abstract Object |
localGet()
|
abstract Object |
localGet(boolean bind)
|
abstract Local |
localScope()
|
abstract Local |
localScope(boolean bind)
|
abstract Object |
localTouch()
|
abstract Object |
localTouch(boolean bind)
|
abstract void |
outputEnd()
ends a cfoutput block |
abstract void |
outputStart()
starts a cfoutput block |
abstract void |
param(String type,
String name,
Object defaultValue)
|
abstract void |
param(String type,
String name,
Object defaultValue,
double min,
double max)
|
abstract void |
param(String type,
String name,
Object defaultValue,
int maxLength)
|
abstract void |
param(String type,
String name,
Object defaultValue,
String pattern)
|
abstract void |
releaseBody(javax.servlet.jsp.tagext.BodyTag bodyTag,
int state)
release body of a tag |
abstract void |
removeLastPageSource(boolean alsoInclude)
remove the last PageSource |
abstract Object |
removeVariable(String var)
|
abstract Request |
requestScope()
|
abstract void |
reuse(javax.servlet.jsp.tagext.Tag tag)
puts a tag back to pool |
abstract Scope |
scope(int type)
returns matching scope |
abstract String |
serialize(Object expression)
|
abstract Server |
serverScope()
|
abstract Session |
sessionScope()
|
abstract Object |
set(Object coll,
Collection.Key key,
Object value)
set property at a collection object |
abstract Object |
set(Object coll,
String key,
Object value)
Deprecated. use instead
|
abstract void |
setApplicationContext(ApplicationContext applicationContext)
|
abstract void |
setCatch(PageException pe)
|
abstract void |
setCatch(PageException pe,
boolean caught,
boolean store)
|
abstract PageException |
setCatch(Throwable t)
sets a excption |
abstract void |
setCFOutputOnly(boolean boolEnablecfoutputonly)
sets state of cfoutput only |
abstract void |
setCFOutputOnly(short enablecfoutputonly)
sets state of cfoutput only |
abstract void |
setErrorPage(ErrorPage ep)
sets the error page |
abstract void |
setExecutionTime(int executionTime)
|
abstract void |
setFunctionScopes(Local local,
Argument argument)
|
abstract void |
setHeader(String name,
String value)
write a value to the header of the response |
abstract void |
setLocale(Locale locale)
|
abstract void |
setLocale(String strLocale)
Deprecated. use instead
|
abstract void |
setPsq(boolean psq)
sets if inside a query tag single quote will be preserved (preserve single quote) |
abstract void |
setRemoteUser(Credential remoteUser)
|
abstract void |
setRequestTimeout(long requestTimeout)
|
abstract boolean |
setSilent()
sets the pagecontext silent |
abstract void |
setThreadScope(Collection.Key name,
Threads t)
|
abstract void |
setThreadScope(String name,
Threads t)
Deprecated. use instead setThreadScope(Collection.Key name,Threads t) |
abstract void |
setTimeZone(TimeZone timeZone)
|
abstract Object |
setVariable(String var,
Object value)
sets a value by string syntax ("scopename.key.key" -> "url.name") |
abstract void |
setVariablesScope(Variables scope)
set a other variable scope |
abstract void |
throwCatch()
return throwed exception |
abstract PageSource |
toPageSource(Resource res,
PageSource defaultValue)
|
abstract Object |
touch(Object coll,
Collection.Key key)
touch a new property, if property doesn't existset a Struct, otherwise do nothing |
abstract Object |
touch(Object coll,
String key)
Deprecated. use instead
|
abstract Undefined |
undefinedScope()
|
abstract boolean |
unsetSilent()
unsets the pagecontext silent |
abstract URLForm |
urlFormScope()
|
abstract URL |
urlScope()
|
abstract Undefined |
us()
|
abstract javax.servlet.jsp.tagext.Tag |
use(Class tagClass)
returns a tag from tag handler pool |
abstract javax.servlet.jsp.tagext.Tag |
use(String tagClassName)
returns a tag from tag handler pool |
abstract Variables |
variablesScope()
|
abstract void |
write(String str)
Writes a String to the Response Buffer |
abstract void |
writePSQ(Object o)
Writes a String to the Response Buffer,also when cfoutputonly is true and execution is outside of a cfoutput |
Methods inherited from class javax.servlet.jsp.PageContext |
---|
findAttribute, forward, getAttribute, getAttribute, getAttributeNamesInScope, getAttributesScope, getException, getOut, getPage, getRequest, getResponse, getServletConfig, getServletContext, getSession, handlePageException, handlePageException, include, initialize, popBody, pushBody, release, removeAttribute, removeAttribute, setAttribute, setAttribute |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public PageContext()
Method Detail |
---|
public abstract Scope scope(int type) throws PageException
type
- type of scope (Scope.xx)
PageException
public abstract Undefined undefinedScope()
public abstract Variables variablesScope()
public abstract URL urlScope()
public abstract Form formScope()
public abstract URLForm urlFormScope()
public abstract Request requestScope()
public abstract CGI cgiScope()
public abstract Application applicationScope() throws PageException
PageException
public abstract Argument argumentsScope()
public abstract Argument argumentsScope(boolean bind)
bind
- indicate that the Argument Scope is binded for using outsite of the udf
public abstract Local localScope()
public abstract Local localScope(boolean bind)
public abstract Object localGet() throws PageException
PageException
public abstract Object localGet(boolean bind) throws PageException
PageException
public abstract Object localTouch() throws PageException
PageException
public abstract Object localTouch(boolean bind) throws PageException
PageException
public abstract Session sessionScope() throws PageException
PageException
public abstract void setFunctionScopes(Local local, Argument argument)
public abstract Server serverScope() throws PageException
PageException
public abstract Cookie cookieScope()
public abstract Client clientScope() throws PageException
PageException
public abstract Client clientScopeEL()
public abstract Cluster clusterScope() throws PageException
PageException
public abstract Cluster clusterScope(boolean create) throws PageException
create
- return null when false and scope does not exist
PageException
public abstract Object set(Object coll, String key, Object value) throws PageException
set(Object, railo.runtime.type.Collection.Key, Object)
coll
- Collection Object (Collection, HashMap aso.)key
- key of the new valuevalue
- new Value
PageException
public abstract Object set(Object coll, Collection.Key key, Object value) throws PageException
coll
- Collection Object (Collection, HashMap aso.)key
- key of the new valuevalue
- new Value
PageException
public abstract Object touch(Object coll, String key) throws PageException
touch(Object, railo.runtime.type.Collection.Key)
coll
- Collection Objectkey
- key to touch
PageException
public abstract Object touch(Object coll, Collection.Key key) throws PageException
coll
- Collection Objectkey
- key to touch
PageException
public abstract Object getCollection(Object coll, String key) throws PageException
getCollection(Object, railo.runtime.type.Collection.Key, Object)
coll
- Collection Objectkey
- key to touch
PageException
public abstract Object getCollection(Object coll, Collection.Key key) throws PageException
coll
- Collection Objectkey
- key to touch
PageException
public abstract Object getCollection(Object coll, String key, Object defaultValue)
getCollection(Object, railo.runtime.type.Collection.Key, Object)
coll
- Collection Objectkey
- key to touch
public abstract Object getCollection(Object coll, Collection.Key key, Object defaultValue)
coll
- Collection Objectkey
- key to touch
public abstract Object get(Object coll, String key) throws PageException
get(Object, railo.runtime.type.Collection.Key)
coll
- Collection to get valuekey
- key of the value
PageException
public abstract Object get(Object coll, Collection.Key key) throws PageException
coll
- Collection to get valuekey
- key of the value
PageException
public abstract Reference getReference(Object coll, String key) throws PageException
getReference(Object, railo.runtime.type.Collection.Key)
coll
- Collection to get valuekey
- key of the value
PageException
public abstract Reference getReference(Object coll, Collection.Key key) throws PageException
coll
- Collection to get valuekey
- key of the value
PageException
public abstract Object get(Object coll, String key, Object defaultValue)
get(Object, railo.runtime.type.Collection.Key, Object)
coll
- Collection to get valuekey
- key of the value
public abstract Object get(Object coll, Collection.Key key, Object defaultValue)
coll
- Collection to get valuekey
- key of the value
public abstract Object setVariable(String var, Object value) throws PageException
var
- Variable String name to setvalue
- value to set
PageException
public abstract Object getVariable(String var) throws PageException
var
- variable name to get
PageException
public abstract Object evaluate(String expression) throws PageException
expression
- expression to evaluate
PageException
public abstract String serialize(Object expression) throws PageException
PageException
public abstract Object removeVariable(String var) throws PageException
var
- variable name to get
PageException
public abstract Query getQuery(String key) throws PageException
key
- Variable Name to get
PageException
public abstract Query getQuery(Object value) throws PageException
PageException
public abstract void setHeader(String name, String value)
name
- name of the value to setvalue
- value to setpublic abstract String getCFID()
public abstract String getCFToken()
public abstract String getJSessionId()
public abstract String getURLToken()
public abstract int getId()
public abstract javax.servlet.jsp.JspWriter getRootWriter()
public abstract Locale getLocale()
public abstract void setLocale(Locale locale)
strLocale
- The locale to set as String.public abstract void setLocale(String strLocale) throws PageException
setLocale(Locale)
strLocale
- The locale to set as String.
PageException
public abstract ConfigWeb getConfig()
public abstract javax.servlet.http.HttpServletRequest getHttpServletRequest()
public abstract javax.servlet.http.HttpServletResponse getHttpServletResponse()
public abstract OutputStream getResponseStream() throws IOException
IOException
public abstract javax.servlet.jsp.tagext.Tag getCurrentTag()
public abstract ApplicationContext getApplicationContext()
public abstract void write(String str) throws IOException
str
-
IOException
public abstract void forceWrite(String str) throws IOException
str
-
IOException
public abstract void writePSQ(Object o) throws IOException, PageException
o
-
IOException
PageException
public abstract PageSource getCurrentPageSource()
public abstract PageSource getCurrentTemplatePageSource()
public abstract PageSource getBasePageSource()
public abstract boolean setSilent()
public abstract boolean unsetSilent()
public abstract Debugger getDebugger()
public abstract int getExecutionTime()
public abstract void setExecutionTime(int executionTime)
executionTime
- The executionTime to set.public abstract Credential getRemoteUser() throws PageException
PageException
public abstract void clearRemoteUser()
public abstract void setRemoteUser(Credential remoteUser)
remoteUser
- The remoteUser to set.public abstract Array getTemplatePath() throws PageException
PageException
public abstract int getCurrentLevel()
public abstract VariableUtil getVariableUtil()
public abstract void setApplicationContext(ApplicationContext applicationContext)
applicationContext
- The applicationContext to set.public abstract PageSource toPageSource(Resource res, PageSource defaultValue)
public abstract void setVariablesScope(Variables scope)
scope
- public abstract void doInclude(PageSource source) throws PageException
source
- absolute path as file object
javax.servlet.ServletException
PageException
public abstract void doInclude(PageSource[] source, boolean runOnce) throws PageException
source
- absolute path as file objectrunOnce
- include only once per request
javax.servlet.ServletException
PageException
public abstract void doInclude(String source) throws PageException
source
- absolute path as file object
javax.servlet.ServletException
PageException
public abstract void doInclude(String source, boolean runOnce) throws PageException
source
- absolute path as file objectrunOnce
- include only once per request
javax.servlet.ServletException
PageException
public abstract void clear()
public abstract FTPPool getFTPPool()
public abstract long getRequestTimeout()
public abstract QueryCache getQueryCache()
public abstract void setRequestTimeout(long requestTimeout)
requestTimeout
- The requestTimeout to set.public abstract void setCFOutputOnly(boolean boolEnablecfoutputonly)
boolEnablecfoutputonly
- public abstract boolean getPsq()
public abstract void close()
public abstract void addPageSource(PageSource ps, boolean alsoInclude)
ps
- alsoInclude
- public abstract void clearCatch()
public abstract void execute(String realPath, boolean throwException) throws PageException
realPath
-
PageException
IOException
public abstract void executeRest(String realPath, boolean throwException) throws PageException
PageException
public abstract void flush()
public abstract Object getFunction(Object coll, String key, Object[] args) throws PageException
coll
- Collection of the UDF Functionkey
- name of the functionargs
- arguments to call the function
PageException
public abstract Object getFunction(Object coll, Collection.Key key, Object[] args) throws PageException
coll
- Collection of the UDF Functionkey
- name of the functionargs
- arguments to call the function
PageException
public abstract Object getFunctionWithNamedValues(Object coll, String key, Object[] args) throws PageException
coll
- Collection of the UDF Functionkey
- name of the functionargs
- arguments to call the function
PageException
public abstract Object getFunctionWithNamedValues(Object coll, Collection.Key key, Object[] args) throws PageException
coll
- Collection of the UDF Functionkey
- name of the functionargs
- arguments to call the function
PageException
public abstract Iterator getIterator(String key) throws PageException
key
- Variable Name to get
PageException
public abstract Resource getRootTemplateDirectory()
public abstract long getStartTime()
public abstract Thread getThread()
public abstract void handlePageException(PageException pe)
pe
- Page Exceptionpublic abstract void outputEnd()
public abstract void outputStart()
public abstract void removeLastPageSource(boolean alsoInclude)
alsoInclude
- public abstract void reuse(javax.servlet.jsp.tagext.Tag tag) throws PageException
tag
- tags to puts back
PageException
public abstract PageException setCatch(Throwable t)
t
-
public abstract PageException getCatch()
public abstract void setCatch(PageException pe)
public abstract void setCatch(PageException pe, boolean caught, boolean store)
public abstract void exeLogStart(int position, String id)
public abstract void exeLogEnd(int position, String id)
public abstract void setCFOutputOnly(short enablecfoutputonly)
enablecfoutputonly
- public abstract void setErrorPage(ErrorPage ep)
ep
- public abstract void setPsq(boolean psq)
psq
- sets preserve single quote for querypublic abstract void throwCatch() throws PageException
PageException
public abstract javax.servlet.jsp.tagext.Tag use(Class tagClass) throws PageException
tagClass
- class to load from ta handler pool
PageException
public abstract javax.servlet.jsp.tagext.Tag use(String tagClassName) throws PageException
tagClassName
-
PageException
public abstract Undefined us()
public abstract void compile(String templatePath) throws PageException
compile(PageSource pageSource)
templatePath
-
PageException
public abstract void compile(PageSource pageSource) throws PageException
pageSource
-
PageException
public abstract void initBody(javax.servlet.jsp.tagext.BodyTag bodyTag, int state) throws javax.servlet.jsp.JspException
bodyTag
- state
-
javax.servlet.jsp.JspException
public abstract void releaseBody(javax.servlet.jsp.tagext.BodyTag bodyTag, int state)
bodyTag
- state
- public abstract void param(String type, String name, Object defaultValue) throws PageException
type
- name
- defaultValue
-
PageException
public abstract void param(String type, String name, Object defaultValue, int maxLength) throws PageException
type
- name
- defaultValue
- maxLength
-
PageException
public abstract void param(String type, String name, Object defaultValue, String pattern) throws PageException
type
- name
- defaultValue
-
PageException
public abstract void param(String type, String name, Object defaultValue, double min, double max) throws PageException
type
- name
- defaultValue
-
PageException
public abstract boolean isCFCRequest()
public abstract DataSourceManager getDataSourceManager()
public abstract CFMLFactory getCFMLFactory()
public abstract PageContext getParentPageContext()
public abstract Threads getThreadScope(String name)
setThreadScope(Collection.Key name,Threads t)
name
-
public abstract Threads getThreadScope(Collection.Key name)
public abstract void setThreadScope(String name, Threads t)
setThreadScope(Collection.Key name,Threads t)
name
- t
- public abstract void setThreadScope(Collection.Key name, Threads t)
public abstract String[] getThreadScopeNames()
public abstract boolean hasFamily()
public abstract Component loadComponent(String compPath) throws PageException
PageException
public abstract Component getActiveComponent()
public abstract UDF getActiveUDF()
public abstract TimeZone getTimeZone()
public abstract void setTimeZone(TimeZone timeZone)
public abstract short getSessionType()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |