|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object javax.faces.component.UIComponent javax.faces.component.UIComponentBase com.esri.adf.web.faces.component.ContextControl
public class ContextControl
The context control establishes a working environment with a GIS server. Based on the specified value binding a
connection to a GIS server is established and maintained.
The ContextControl works with WebContext
object. The ContextTag
class
wraps the functionality of the ContextControl and enables the use of the context tag in a JSP page.
Field Summary | |
---|---|
static String |
COMPONENT_FAMILY
The standard component family for this component. |
static String |
COMPONENT_TYPE
The standard component type for this component. |
static String |
CONTEXT_IDS_LIST
The client IDs of the ContextControls on the page are stored under this list. |
Fields inherited from class javax.faces.component.UIComponent |
---|
bindings |
Constructor Summary | |
---|---|
ContextControl()
Creates a new ContextControl. |
Method Summary | |
---|---|
void |
encodeBegin(javax.faces.context.FacesContext facesContext)
Performs the initialization required when encoding of the control begins. |
String |
getFamily()
Returns the family of this control. |
Object |
getValue()
|
WebContext |
getWebContext()
Returns the WebContext associated with this control. |
boolean |
isInit()
Returns whether or not a control is initialized. |
boolean |
isPreserve()
Returns whether or not the previous context should be preserved when the resource is changed. |
void |
restoreState(javax.faces.context.FacesContext facesContext,
Object state)
Restores the state of the control. |
Object |
saveState(javax.faces.context.FacesContext facesContext)
Saves the state of this control. |
void |
setInit(boolean init)
Sets the control to be initialized. |
void |
setPreserve(boolean preserve)
Sets whether or not the previous context should be preserved when the resource is changed. |
void |
setValue(Object value)
|
void |
setValueExpression(String name,
javax.el.ValueExpression binding)
Sets the value binding. |
Methods inherited from class javax.faces.component.UIComponentBase |
---|
addFacesListener, broadcast, decode, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding |
Methods inherited from class javax.faces.component.UIComponent |
---|
encodeAll, getContainerClientId, getValueExpression |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String COMPONENT_FAMILY
public static final String COMPONENT_TYPE
public static final String CONTEXT_IDS_LIST
Constructor Detail |
---|
public ContextControl()
Method Detail |
---|
public void setValueExpression(String name, javax.el.ValueExpression binding)
setValueExpression
in class javax.faces.component.UIComponent
name
- the name of the attribute or property for which to set a ValueBindingbinding
- the ValueBinding to set. If null, remove any currently set ValueBinding.public void setValue(Object value)
public Object getValue()
public void encodeBegin(javax.faces.context.FacesContext facesContext)
WebContext
in session scope. The WebContext can be retrieved from session using the ID of the context control.
encodeBegin
in class javax.faces.component.UIComponentBase
facesContext
- the FacesContext
public WebContext getWebContext()
WebContext
associated with this control.
WebContext
- the WebContextpublic boolean isPreserve()
public void setPreserve(boolean preserve)
preserve
- if true, the context is preserved. The default is true.public void setInit(boolean init)
init
- if true, perform the initializationpublic boolean isInit()
public String getFamily()
getFamily
in class javax.faces.component.UIComponent
String
- the COMPONENT_FAMILY
public Object saveState(javax.faces.context.FacesContext facesContext)
saveState
in interface javax.faces.component.StateHolder
saveState
in class javax.faces.component.UIComponentBase
facesContext
- the associated FacesContext
Object
- the object to be savedpublic void restoreState(javax.faces.context.FacesContext facesContext, Object state)
restoreState
in interface javax.faces.component.StateHolder
restoreState
in class javax.faces.component.UIComponentBase
facesContext
- the associated FacesContextstate
- the object to restore the state of the control from
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |