com.esri.adf.web.faces.component
Class UIToolbar

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          com.esri.adf.web.faces.component.UIToolbar

All Implemented Interfaces:

javax.faces.component.StateHolder

Direct Known Subclasses:

ToolbarControl

public class UIToolbar
extends javax.faces.component.UIComponentBase

The UIToolbar class provides the server side properties that are required for the Toolbar control.

Field Summary

static java.lang.String	COMPONENT_FAMILY The standard component family for this component.
static java.lang.String	COMPONENT_TYPE The standard component type for this component.

Constructor Summary

UIToolbar()
Initializes the UIToolbar and sets the renderer type.

Method Summary

java.lang.String	getActiveTool() Returns the active tool.
java.lang.String	getFamily() Returns the family of this control.
java.lang.String	getMapId() Returns the map control id associated with the control.
java.io.File	getXslFile() Returns the XSL file name used to render the control.
java.net.URL	getXslUrl() Returns the URL of the XSL file used to render the control.
boolean	isInit() Indicates whether the control is initialized.
void	restoreState(javax.faces.context.FacesContext facesContext, java.lang.Object state) Restores the state of the control.
java.lang.Object	saveState(javax.faces.context.FacesContext facesContext) Saves the state of the control.
void	setActiveTool(java.lang.String activeTool) Sets the active tool for the map.
void	setInit(boolean init) Sets an indicator whether to initialize the control.
void	setMapId(java.lang.String mapId) Sets the control ID.
void	setXslFile(java.io.File xslFile) Sets the XSL file name used to render the control.
void	setXslUrl(java.net.URL xslUrl) Sets the URL of the XSL file used to render the control.

Methods inherited from class javax.faces.component.UIComponentBase

addFacesListener, broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding

Methods inherited from class java.lang.Object

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

Field Detail

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

The standard component type for this component.

See Also:

Constant Field Values

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY

The standard component family for this component.

See Also:

Constant Field Values

Constructor Detail

UIToolbar

public UIToolbar()

Initializes the UIToolbar and sets the renderer type.

Method Detail

getFamily

public java.lang.String getFamily()

Returns the family of this control.

Specified by:

getFamily in class javax.faces.component.UIComponent

Returns:

String- the COMPONENT_FAMILY

isInit

public boolean isInit()

Indicates whether the control is initialized.

Returns:

boolean- if true, the control is initialized

setInit

public void setInit(boolean init)

Sets an indicator whether to initialize the control.

Parameters:

init - if true, initialize the control

getMapId

public java.lang.String getMapId()

Returns the map control id associated with the control.

Returns:

String - the map control id

setMapId

public void setMapId(java.lang.String mapId)

Sets the control ID. The map control id.

Parameters:

mapId - the map control id

getActiveTool

public java.lang.String getActiveTool()

Returns the active tool.

Returns:

String- the active tool

setActiveTool

public void setActiveTool(java.lang.String activeTool)

Sets the active tool for the map. The tool key is defined in the XML tool collection file.

Parameters:

activeTool - the active tool

getXslFile

public java.io.File getXslFile()

Returns the XSL file name used to render the control.

Returns:

File- the XSL file name

setXslFile

public void setXslFile(java.io.File xslFile)

Sets the XSL file name used to render the control.

Parameters:

xslFile - the XSL file name

getXslUrl

public java.net.URL getXslUrl()

Returns the URL of the XSL file used to render the control.

Returns:

URL- the URL object

setXslUrl

public void setXslUrl(java.net.URL xslUrl)

Sets the URL of the XSL file used to render the control.

Parameters:

xslUrl - the URL of the XSL file

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext facesContext)

Saves the state of the control.

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class javax.faces.component.UIComponentBase

Parameters:

facesContext - the associated FacesContext

Returns:

Object- the object to be saved

restoreState

public void restoreState(javax.faces.context.FacesContext facesContext,
                         java.lang.Object state)

Restores the state of the control.

Specified by:

restoreState in interface javax.faces.component.StateHolder

Overrides:

restoreState in class javax.faces.component.UIComponentBase

Parameters:

facesContext - the associated FacesContext

state - the object from which to restore the state of the control