railo.runtime.type.scope
Class FormImpl

java.lang.Object
  extended by railo.runtime.type.util.StructSupport
      extended by railo.runtime.type.StructImpl
          extended by railo.runtime.type.scope.ScopeSupport
              extended by railo.runtime.type.scope.FormImpl
All Implemented Interfaces:
Serializable, Cloneable, Map, Dumpable, Castable, Collection, Iteratorable, Scope, Form, FormUpload, ScriptProtected, Sizeable, Struct

public final class FormImpl
extends ScopeSupport
implements Form, ScriptProtected, FormUpload

Form Scope

See Also:
Serialized Form

Nested Class Summary
 class FormImpl.Item
           
 
Nested classes/interfaces inherited from interface railo.runtime.type.Collection
Collection.Key
 
Nested classes/interfaces inherited from interface java.util.Map
Map.Entry<K,V>
 
Field Summary
 
Fields inherited from class railo.runtime.type.scope.ScopeSupport
APPLICATION, CGI, CLIENT, CLUSTER, COOKIE, FORM, REQUEST, SCOPE_COUNT, SCOPE_VAR, SESSION, URL
 
Fields inherited from class railo.runtime.type.StructImpl
TYPE_SOFT
 
Fields inherited from interface railo.runtime.type.Scope
SCOPE_APPLICATION, SCOPE_ARGUMENTS, SCOPE_CALLER, SCOPE_CGI, SCOPE_CLIENT, SCOPE_CLUSTER, SCOPE_COOKIE, SCOPE_COUNT, SCOPE_FORM, SCOPE_LOCAL, SCOPE_REQUEST, SCOPE_SERVER, SCOPE_SESSION, SCOPE_UNDEFINED, SCOPE_URL, SCOPE_VARIABLES
 
Fields inherited from interface railo.runtime.type.Struct
TYPE_LINKED, TYPE_REGULAR, TYPE_SYNC, TYPE_WEAKED
 
Fields inherited from interface railo.runtime.type.scope.ScriptProtected
NO, UNDEFINED, YES
 
Constructor Summary
FormImpl()
          standart class Constructor
 
Method Summary
 void addRaw(URLItem[] raw)
           
 String getEncoding()
           
 FormImpl.Item[] getFileItems()
           
 org.apache.commons.fileupload.disk.DiskFileItem getFileUpload(String key)
          FUTURE replace with other return type return a file upload object
 PageException getInitException()
           
 javax.servlet.ServletInputStream getInputStream()
           
 URLItem[] getRaw()
           
 FormImpl.Item getUploadResource(String key)
           
 void initialize(PageContext pc)
          Initalize Scope
 boolean isScriptProtected()
           
 void release()
          release scope for reuse
 void setEncoding(String encoding)
           
 void setScriptProtecting(boolean scriptProtected)
          transform the string values of the scope do a script protecting way
 
Methods inherited from class railo.runtime.type.scope.ScopeSupport
_getId, getType, getTypeAsString, isInitalized, sizeOf, toDumpData, toDumpData
 
Methods inherited from class railo.runtime.type.StructImpl
clear, containsKey, containsValue, copy, duplicate, get, get, keyIterator, keys, keysAsString, remove, remove, removeEL, set, setEL, size, valueIterator, values
 
Methods inherited from class railo.runtime.type.util.StructSupport
castToBoolean, castToBooleanValue, castToDateTime, castToDateTime, castToDoubleValue, castToDoubleValue, castToString, castToString, clone, compareTo, compareTo, compareTo, compareTo, containsKey, containsKey, entrySet, equals, get, get, get, invalidKey, isEmpty, iterator, keySet, put, putAll, remove, set, setEL, toString
 
Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface railo.runtime.type.Scope
getType, getTypeAsString, isInitalized
 
Methods inherited from interface railo.runtime.type.Collection
clear, clone, containsKey, containsKey, duplicate, get, get, get, get, keys, keysAsString, remove, removeEL, set, set, setEL, setEL, size
 
Methods inherited from interface railo.runtime.dump.Dumpable
toDumpData
 
Methods inherited from interface railo.runtime.type.Iteratorable
iterator, keyIterator, valueIterator
 
Methods inherited from interface railo.runtime.op.Castable
castToBoolean, castToBooleanValue, castToDateTime, castToDateTime, castToDoubleValue, castToDoubleValue, castToString, castToString, compareTo, compareTo, compareTo, compareTo
 
Methods inherited from interface java.util.Map
clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values
 

Constructor Detail

FormImpl

public FormImpl()
standart class Constructor

Method Detail

getEncoding

public String getEncoding()
Specified by:
getEncoding in interface Form
Returns:
Returns the encoding.
See Also:
Form.getEncoding()

setEncoding

public void setEncoding(String encoding)
                 throws UnsupportedEncodingException
Specified by:
setEncoding in interface Form
Parameters:
encoding - The encoding to set.
Throws:
UnsupportedEncodingException
See Also:
Form.setEncoding(java.lang.String)

initialize

public void initialize(PageContext pc)
Description copied from interface: Scope
Initalize Scope

Specified by:
initialize in interface Scope
Overrides:
initialize in class ScopeSupport
Parameters:
pc - Page Context
See Also:
ScopeSupport.initialize(railo.runtime.PageContext)

release

public void release()
Description copied from interface: Scope
release scope for reuse

Specified by:
release in interface Scope
Overrides:
release in class ScopeSupport
See Also:
Scope.release()

getFileItems

public FormImpl.Item[] getFileItems()
Specified by:
getFileItems in interface FormUpload

getFileUpload

public org.apache.commons.fileupload.disk.DiskFileItem getFileUpload(String key)
Description copied from interface: Form
FUTURE replace with other return type return a file upload object

Specified by:
getFileUpload in interface Form
Parameters:
key - name of the form field
Returns:
apache default file item object (File Object)
See Also:
Form.getFileUpload(java.lang.String)

getUploadResource

public FormImpl.Item getUploadResource(String key)
Specified by:
getUploadResource in interface FormUpload

getInitException

public PageException getInitException()
Specified by:
getInitException in interface Form
Returns:
return the exception when initialised
See Also:
Form.getInitException()

setScriptProtecting

public void setScriptProtecting(boolean scriptProtected)
Description copied from interface: ScriptProtected
transform the string values of the scope do a script protecting way

Specified by:
setScriptProtecting in interface Form
Specified by:
setScriptProtecting in interface ScriptProtected
See Also:
URL.setScriptProtecting(boolean)

isScriptProtected

public boolean isScriptProtected()
Specified by:
isScriptProtected in interface ScriptProtected
Returns:
returns if the values of the scope are already protected against cross site scripting
See Also:
railo.runtime.type.scope.URL#isScriptProtected()

getRaw

public URLItem[] getRaw()
Returns:
the raw

addRaw

public void addRaw(URLItem[] raw)

getInputStream

public javax.servlet.ServletInputStream getInputStream()
Specified by:
getInputStream in interface FormUpload
Returns:
return content as a http header input stream


Copyright © 2012 Railo