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

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

All Implemented Interfaces:

ToolbarItem, javax.faces.component.StateHolder

public class SeparatorControl
extends javax.faces.component.UIComponentBase
implements ToolbarItem

The Separator control is used to separate toolbar items based on the specified separator image, space, or image and space.

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

SeparatorControl()
Initializes the Separator Control and sets the renderer type to null.

Method Summary

org.w3c.dom.Element	generateXML() Generates an XML representation of the control.
java.lang.String	getFamily() Returns the family of this control.
java.lang.String	getImage() Returns the separator image.
protected javax.faces.render.Renderer	getRenderer(javax.faces.context.FacesContext context) Returns a design-time renderer if the component is used in an IDE.
java.lang.String	getStyle() Returns the style attributes of the Separator control.
java.lang.String	getStyleClass() Returns the file name where the CSS style attributes are defined.
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 this control.
void	setImage(java.lang.String image) Sets the separator image for this control.
void	setInit(boolean init) Sets an indicator whether to initialize the control.
void	setStyle(java.lang.String style) Sets the default style for the Separator control.
void	setStyleClass(java.lang.String styleClass) Sets the CSS class name where the CSS style attributes are defined.

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, 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_FAMILY

public static final java.lang.String COMPONENT_FAMILY

The standard component family for this component.

See Also:

Constant Field Values

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

The standard component type for this component.

See Also:

Constant Field Values

Constructor Detail

SeparatorControl

public SeparatorControl()

Initializes the Separator Control and sets the renderer type to null. The renderer type is set to null since the parent Toolbar Control is responsible for rendering this control.

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

getRenderer

protected javax.faces.render.Renderer getRenderer(javax.faces.context.FacesContext context)

Returns a design-time renderer if the component is used in an IDE.

Overrides:

getRenderer in class javax.faces.component.UIComponentBase

Parameters:

context - the FacesContext

Returns:

Renderer- the renderer object

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

getStyle

public java.lang.String getStyle()

Returns the style attributes of the Separator control.

Returns:

String- the style attributes

setStyle

public void setStyle(java.lang.String style)

Sets the default style for the Separator control.

Parameters:

style - the default style for the Separator control

getStyleClass

public java.lang.String getStyleClass()

Returns the file name where the CSS style attributes are defined.

Returns:

String- the CSS class

setStyleClass

public void setStyleClass(java.lang.String styleClass)

Sets the CSS class name where the CSS style attributes are defined.

Parameters:

styleClass - the CSS class

getImage

public java.lang.String getImage()

Returns the separator image.

Returns:

String- the separator image

setImage

public void setImage(java.lang.String image)

Sets the separator image for this control.

Parameters:

image - the separator image for this control

saveState

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

Saves the state of this 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

generateXML

public org.w3c.dom.Element generateXML()

Generates an XML representation of the control.

Specified by:

generateXML in interface ToolbarItem

Returns:

Element- the XML element of the control