org.apache.myfaces.custom.swapimage
Class HtmlSwapImage

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UIGraphic
              org.apache.myfaces.custom.swapimage.AbstractHtmlSwapImage
                  org.apache.myfaces.custom.swapimage.HtmlSwapImage

All Implemented Interfaces:

javax.faces.component.StateHolder, AlignProperty, StyleAware, UniversalProperties

public class HtmlSwapImage
extends AbstractHtmlSwapImage

Field Summary

static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static java.lang.String	DEFAULT_RENDERER_TYPE

Constructor Summary

HtmlSwapImage()

Method Summary

java.lang.String	getActiveImageUrl() activeImage will be rendered if: swapImage is a direct child of commandNavigation and the commandNavigation.isActive
java.lang.String	getAlign() HTML: Specifies the horizontal alignment of this element.
java.lang.String	getAlt() HTML: Specifies alternative text that can be used by a browser that can't show this element.
java.lang.String	getBorder() HTML: Specifies the width of the border of this element, in pixels.
java.lang.String	getDir() HTML: The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).
java.lang.String	getFamily()
java.lang.String	getHeight() HTML: Overrides the natural height of this image, by specifying height in pixels.
java.lang.String	getHspace() HTML: The amount of white space to be inserted to the left and right of this element, in undefined units.
java.lang.String	getLang() HTML: The base language of this document.
java.lang.String	getLongdesc() HTML: A link to a long description of the image.
java.lang.String	getOnclick() HTML: Script to be invoked when the element is clicked.
java.lang.String	getOndblclick() HTML: Script to be invoked when the element is double-clicked.
java.lang.String	getOnkeydown() HTML: Script to be invoked when a key is pressed down over this element.
java.lang.String	getOnkeypress() HTML: Script to be invoked when a key is pressed over this element.
java.lang.String	getOnkeyup() HTML: Script to be invoked when a key is released over this element.
java.lang.String	getStyle() HTML: CSS styling instructions.
java.lang.String	getStyleClass() The CSS class for this element.
java.lang.String	getSwapImageUrl() the url of the image displayed onmouseover
java.lang.String	getTitle() HTML: An advisory title for this element.
java.lang.String	getUsemap() HTML: Specifies an image map to use with this image.
java.lang.String	getVspace() HTML: The amount of white space to be inserted above and below this element, in undefined units.
java.lang.String	getWidth() HTML: Overrides the natural width of this image, by specifying width in pixels.
boolean	isIsmap() HTML: Specifies server-side image map handling for this image.
void	restoreState(javax.faces.context.FacesContext facesContext, java.lang.Object state)
java.lang.Object	saveState(javax.faces.context.FacesContext facesContext)
void	setActiveImageUrl(java.lang.String activeImageUrl)
void	setAlign(java.lang.String align)
void	setAlt(java.lang.String alt)
void	setBorder(java.lang.String border)
void	setDir(java.lang.String dir)
void	setHeight(java.lang.String height)
void	setHspace(java.lang.String hspace)
void	setIsmap(boolean ismap)
void	setLang(java.lang.String lang)
void	setLongdesc(java.lang.String longdesc)
void	setOnclick(java.lang.String onclick)
void	setOndblclick(java.lang.String ondblclick)
void	setOnkeydown(java.lang.String onkeydown)
void	setOnkeypress(java.lang.String onkeypress)
void	setOnkeyup(java.lang.String onkeyup)
void	setStyle(java.lang.String style)
void	setStyleClass(java.lang.String styleClass)
void	setSwapImageUrl(java.lang.String swapImageUrl)
void	setTitle(java.lang.String title)
void	setUsemap(java.lang.String usemap)
void	setVspace(java.lang.String vspace)
void	setWidth(java.lang.String width)

Methods inherited from class org.apache.myfaces.custom.swapimage.AbstractHtmlSwapImage

isRendered

Methods inherited from class javax.faces.component.UIGraphic

getUrl, getValue, getValueBinding, setUrl, setValue, setValueBinding

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, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient

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

See Also:

Constant Field Values

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

DEFAULT_RENDERER_TYPE

public static final java.lang.String DEFAULT_RENDERER_TYPE

See Also:

Constant Field Values

Constructor Detail

HtmlSwapImage

public HtmlSwapImage()

Method Detail

getFamily

public java.lang.String getFamily()

Overrides:

getFamily in class javax.faces.component.UIGraphic

getBorder

public java.lang.String getBorder()

Description copied from class: AbstractHtmlSwapImage

HTML: Specifies the width of the border of this element, in pixels. Deprecated in HTML 4.01.

Specified by:

getBorder in class AbstractHtmlSwapImage

setBorder

public void setBorder(java.lang.String border)

getHspace

public java.lang.String getHspace()

Description copied from class: AbstractHtmlSwapImage

HTML: The amount of white space to be inserted to the left and right of this element, in undefined units. Deprecated in HTML 4.01.

Specified by:

getHspace in class AbstractHtmlSwapImage

setHspace

public void setHspace(java.lang.String hspace)

getVspace

public java.lang.String getVspace()

Description copied from class: AbstractHtmlSwapImage

HTML: The amount of white space to be inserted above and below this element, in undefined units. Deprecated in HTML 4.01.

Specified by:

getVspace in class AbstractHtmlSwapImage

setVspace

public void setVspace(java.lang.String vspace)

getSwapImageUrl

public java.lang.String getSwapImageUrl()

Description copied from class: AbstractHtmlSwapImage

the url of the image displayed onmouseover

Specified by:

getSwapImageUrl in class AbstractHtmlSwapImage

setSwapImageUrl

public void setSwapImageUrl(java.lang.String swapImageUrl)

getActiveImageUrl

public java.lang.String getActiveImageUrl()

Description copied from class: AbstractHtmlSwapImage

activeImage will be rendered if: swapImage is a direct child of commandNavigation and the commandNavigation.isActive

Specified by:

getActiveImageUrl in class AbstractHtmlSwapImage

setActiveImageUrl

public void setActiveImageUrl(java.lang.String activeImageUrl)

getAlt

public java.lang.String getAlt()

Description copied from class: AbstractHtmlSwapImage

HTML: Specifies alternative text that can be used by a browser that can't show this element.

Specified by:

getAlt in class AbstractHtmlSwapImage

setAlt

public void setAlt(java.lang.String alt)

getHeight

public java.lang.String getHeight()

Description copied from class: AbstractHtmlSwapImage

HTML: Overrides the natural height of this image, by specifying height in pixels.

Specified by:

getHeight in class AbstractHtmlSwapImage

setHeight

public void setHeight(java.lang.String height)

isIsmap

public boolean isIsmap()

Description copied from class: AbstractHtmlSwapImage

HTML: Specifies server-side image map handling for this image.

Specified by:

isIsmap in class AbstractHtmlSwapImage

setIsmap

public void setIsmap(boolean ismap)

getLongdesc

public java.lang.String getLongdesc()

Description copied from class: AbstractHtmlSwapImage

HTML: A link to a long description of the image.

Specified by:

getLongdesc in class AbstractHtmlSwapImage

setLongdesc

public void setLongdesc(java.lang.String longdesc)

getOnclick

public java.lang.String getOnclick()

Description copied from class: AbstractHtmlSwapImage

HTML: Script to be invoked when the element is clicked.

Specified by:

getOnclick in class AbstractHtmlSwapImage

setOnclick

public void setOnclick(java.lang.String onclick)

getOndblclick

public java.lang.String getOndblclick()

Description copied from class: AbstractHtmlSwapImage

HTML: Script to be invoked when the element is double-clicked.

Specified by:

getOndblclick in class AbstractHtmlSwapImage

setOndblclick

public void setOndblclick(java.lang.String ondblclick)

getOnkeydown

public java.lang.String getOnkeydown()

Description copied from class: AbstractHtmlSwapImage

HTML: Script to be invoked when a key is pressed down over this element.

Specified by:

getOnkeydown in class AbstractHtmlSwapImage

setOnkeydown

public void setOnkeydown(java.lang.String onkeydown)

getOnkeypress

public java.lang.String getOnkeypress()

Description copied from class: AbstractHtmlSwapImage

HTML: Script to be invoked when a key is pressed over this element.

Specified by:

getOnkeypress in class AbstractHtmlSwapImage

setOnkeypress

public void setOnkeypress(java.lang.String onkeypress)

getOnkeyup

public java.lang.String getOnkeyup()

Description copied from class: AbstractHtmlSwapImage

HTML: Script to be invoked when a key is released over this element.

Specified by:

getOnkeyup in class AbstractHtmlSwapImage

setOnkeyup

public void setOnkeyup(java.lang.String onkeyup)

getUsemap

public java.lang.String getUsemap()

Description copied from class: AbstractHtmlSwapImage

HTML: Specifies an image map to use with this image.

Specified by:

getUsemap in class AbstractHtmlSwapImage

setUsemap

public void setUsemap(java.lang.String usemap)

getWidth

public java.lang.String getWidth()

Description copied from class: AbstractHtmlSwapImage

HTML: Overrides the natural width of this image, by specifying width in pixels.

Specified by:

getWidth in class AbstractHtmlSwapImage

setWidth

public void setWidth(java.lang.String width)

getDir

public java.lang.String getDir()

Description copied from interface: UniversalProperties

HTML: The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).

setDir

public void setDir(java.lang.String dir)

getLang

public java.lang.String getLang()

Description copied from interface: UniversalProperties

HTML: The base language of this document.

setLang

public void setLang(java.lang.String lang)

getTitle

public java.lang.String getTitle()

Description copied from interface: UniversalProperties

HTML: An advisory title for this element. Often used by the user agent as a tooltip.

setTitle

public void setTitle(java.lang.String title)

getStyle

public java.lang.String getStyle()

Description copied from interface: StyleAware

HTML: CSS styling instructions.

setStyle

public void setStyle(java.lang.String style)

getStyleClass

public java.lang.String getStyleClass()

Description copied from interface: StyleAware

The CSS class for this element. Corresponds to the HTML 'class' attribute.

setStyleClass

public void setStyleClass(java.lang.String styleClass)

getAlign

public java.lang.String getAlign()

Description copied from interface: AlignProperty

HTML: Specifies the horizontal alignment of this element. Deprecated in HTML 4.01.

setAlign

public void setAlign(java.lang.String align)

saveState

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

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class javax.faces.component.UIGraphic

restoreState

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

Specified by:

restoreState in interface javax.faces.component.StateHolder

Overrides:

restoreState in class javax.faces.component.UIGraphic