com.icesoft.faces.component.ext

Class HtmlGraphicImage

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

javax.faces.component.UIGraphic

javax.faces.component.html.HtmlGraphicImage

com.icesoft.faces.component.ext.HtmlGraphicImage

All Implemented Interfaces:

java.util.EventListener, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder

public class HtmlGraphicImage
extends javax.faces.component.html.HtmlGraphicImage

This is an extension of javax.faces.component.html.HtmlGraphicImage, which provides some additional behavior to this component such as:

• changes the component's rendered state based on the authentication
• adds effects to the component

Nested Class Summary

Nested classes/interfaces inherited from class javax.faces.component.html.HtmlGraphicImage

javax.faces.component.html.HtmlGraphicImage.PropertyKeys

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COMPONENT_TYPE
static java.lang.String	RENDERER_TYPE

Fields inherited from class javax.faces.component.UIGraphic

COMPONENT_FAMILY

Fields inherited from class javax.faces.component.UIComponent

ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY

Constructor Summary

Constructors

Constructor and Description
HtmlGraphicImage()

Method Summary

Modifier and Type	Method and Description
void	encodeBegin(javax.faces.context.FacesContext context)
java.lang.String	getByteArrayImagePath(javax.faces.context.FacesContext context)
com.icesoft.faces.context.effects.CurrentStyle	getCurrentStyle() Return the value of the currentStyle property.
com.icesoft.faces.context.effects.Effect	getEffect() Return the value of the effect property.
java.lang.String	getMimeType()
com.icesoft.faces.context.effects.Effect	getOnclickeffect() Return the value of the onclickeffect property.
com.icesoft.faces.context.effects.Effect	getOndblclickeffect() Return the value of the ondblclickeffect property.
com.icesoft.faces.context.effects.Effect	getOnkeydowneffect() Return the value of the onkeydowneffect property.
com.icesoft.faces.context.effects.Effect	getOnkeypresseffect() Return the value of the onkeypresseffect property.
com.icesoft.faces.context.effects.Effect	getOnkeyupeffect() Return the value of the onkeyupeffect property.
com.icesoft.faces.context.effects.Effect	getOnmousedowneffect() Return the value of the onmousedowneffect property.
com.icesoft.faces.context.effects.Effect	getOnmousemoveeffect() Return the value of the onmousemoveeffect property.
com.icesoft.faces.context.effects.Effect	getOnmouseouteffect() Return the value of the onmouseouteffect property.
com.icesoft.faces.context.effects.Effect	getOnmouseovereffect() Return the value of the onmouseovereffect property.
com.icesoft.faces.context.effects.Effect	getOnmouseupeffect() Return the value of the onmouseupeffect property.
java.lang.String	getRenderedOnUserRole() Return the value of the renderedOnUserRole property.
java.lang.String	getStyleClass() Return the value of the styleClass property.
boolean	getVisible() Return the value of the visible property.
boolean	isRendered() Return the value of the rendered property.
void	restoreState(javax.faces.context.FacesContext context, java.lang.Object state) Perform any processing required to restore the state from the entries in the state Object.
java.lang.Object	saveState(javax.faces.context.FacesContext context) Gets the state of the instance as a Serializable Object.
void	setCurrentStyle(com.icesoft.faces.context.effects.CurrentStyle currentStyle) Set the value of the currentStyle property.
void	setEffect(com.icesoft.faces.context.effects.Effect effect) Set the value of the effect property.
void	setMimeType(java.lang.String mimeType)
void	setOnclickeffect(com.icesoft.faces.context.effects.Effect onclickeffect) Set the value of the onclickeffect property.
void	setOndblclickeffect(com.icesoft.faces.context.effects.Effect ondblclickeffect) Set the value of the ondblclickeffect property.
void	setOnkeydowneffect(com.icesoft.faces.context.effects.Effect onkeydowneffect) Set the value of the onkeydowneffect property.
void	setOnkeypresseffect(com.icesoft.faces.context.effects.Effect onkeypresseffect) Set the value of the onkeypresseffect property.
void	setOnkeyupeffect(com.icesoft.faces.context.effects.Effect onkeyupeffect) Set the value of the onkeyupeffect property.
void	setOnmousedowneffect(com.icesoft.faces.context.effects.Effect onmousedowneffect) Set the value of the onmousedowneffect property.
void	setOnmousemoveeffect(com.icesoft.faces.context.effects.Effect onmousemoveeffect) Set the value of the onmousemoveeffect property.
void	setOnmouseouteffect(com.icesoft.faces.context.effects.Effect onmouseouteffect) Set the value of the onmouseouteffect property.
void	setOnmouseovereffect(com.icesoft.faces.context.effects.Effect onmouseovereffect) Set the value of the onmouseovereffect property.
void	setOnmouseupeffect(com.icesoft.faces.context.effects.Effect onmouseupeffect) Set the value of the onmouseupeffect property.
void	setRenderedOnUserRole(java.lang.String renderedOnUserRole) Set the value of the renderedOnUserRole property.
void	setStyleClass(java.lang.String styleClass) Set the value of the styleClass property.
void	setValueBinding(java.lang.String s, javax.faces.el.ValueBinding vb)
void	setVisible(boolean visible) Set the value of the visible property.

Methods inherited from class javax.faces.component.html.HtmlGraphicImage

getAlt, getDefaultEventName, getDir, getEventNames, getHeight, getLang, getLongdesc, getOnclick, getOndblclick, getOnkeydown, getOnkeypress, getOnkeyup, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, getStyle, getTitle, getUsemap, getWidth, isIsmap, setAlt, setDir, setHeight, setIsmap, setLang, setLongdesc, setOnclick, setOndblclick, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setStyle, setTitle, setUsemap, setWidth

Methods inherited from class javax.faces.component.UIGraphic

getFamily, getUrl, getValue, getValueBinding, getValueExpression, setUrl, setValue, setValueExpression

Methods inherited from class javax.faces.component.UIComponentBase

addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getRenderer, getRendererType, getRendersChildren, invokeOnComponent, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, visitTree

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder

addClientBehavior, getClientBehaviors

Field Detail

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

RENDERER_TYPE

public static final java.lang.String RENDERER_TYPE

See Also:

Constant Field Values

Constructor Detail

HtmlGraphicImage

public HtmlGraphicImage()

Method Detail

setValueBinding

public void setValueBinding(java.lang.String s,
                            javax.faces.el.ValueBinding vb)

Overrides:

setValueBinding in class javax.faces.component.UIGraphic

encodeBegin

public void encodeBegin(javax.faces.context.FacesContext context)
                 throws java.io.IOException

Overrides:

encodeBegin in class javax.faces.component.UIComponentBase

Throws:

java.io.IOException

setEffect

public void setEffect(com.icesoft.faces.context.effects.Effect effect)

Set the value of the effect property.

getEffect

public com.icesoft.faces.context.effects.Effect getEffect()

Return the value of the effect property.

setVisible

public void setVisible(boolean visible)

Set the value of the visible property.

getVisible

public boolean getVisible()

Return the value of the visible property.

setRenderedOnUserRole

public void setRenderedOnUserRole(java.lang.String renderedOnUserRole)

Set the value of the renderedOnUserRole property.

getRenderedOnUserRole

public java.lang.String getRenderedOnUserRole()

Return the value of the renderedOnUserRole property.

isRendered

public boolean isRendered()

Return the value of the rendered property.

Overrides:

isRendered in class javax.faces.component.UIComponentBase

getOnclickeffect

public com.icesoft.faces.context.effects.Effect getOnclickeffect()

Return the value of the onclickeffect property.

setOnclickeffect

public void setOnclickeffect(com.icesoft.faces.context.effects.Effect onclickeffect)

Set the value of the onclickeffect property.

getOndblclickeffect

public com.icesoft.faces.context.effects.Effect getOndblclickeffect()

Return the value of the ondblclickeffect property.

setOndblclickeffect

public void setOndblclickeffect(com.icesoft.faces.context.effects.Effect ondblclickeffect)

Set the value of the ondblclickeffect property.

getOnmousedowneffect

public com.icesoft.faces.context.effects.Effect getOnmousedowneffect()

Return the value of the onmousedowneffect property.

setOnmousedowneffect

public void setOnmousedowneffect(com.icesoft.faces.context.effects.Effect onmousedowneffect)

Set the value of the onmousedowneffect property.

getOnmouseupeffect

public com.icesoft.faces.context.effects.Effect getOnmouseupeffect()

Return the value of the onmouseupeffect property.

setOnmouseupeffect

public void setOnmouseupeffect(com.icesoft.faces.context.effects.Effect onmouseupeffect)

Set the value of the onmouseupeffect property.

getOnmousemoveeffect

public com.icesoft.faces.context.effects.Effect getOnmousemoveeffect()

Return the value of the onmousemoveeffect property.

setOnmousemoveeffect

public void setOnmousemoveeffect(com.icesoft.faces.context.effects.Effect onmousemoveeffect)

Set the value of the onmousemoveeffect property.

getOnmouseovereffect

public com.icesoft.faces.context.effects.Effect getOnmouseovereffect()

Return the value of the onmouseovereffect property.

setOnmouseovereffect

public void setOnmouseovereffect(com.icesoft.faces.context.effects.Effect onmouseovereffect)

Set the value of the onmouseovereffect property.

getOnmouseouteffect

public com.icesoft.faces.context.effects.Effect getOnmouseouteffect()

Return the value of the onmouseouteffect property.

setOnmouseouteffect

public void setOnmouseouteffect(com.icesoft.faces.context.effects.Effect onmouseouteffect)

Set the value of the onmouseouteffect property.

getOnkeypresseffect

public com.icesoft.faces.context.effects.Effect getOnkeypresseffect()

Return the value of the onkeypresseffect property.

setOnkeypresseffect

public void setOnkeypresseffect(com.icesoft.faces.context.effects.Effect onkeypresseffect)

Set the value of the onkeypresseffect property.

getOnkeydowneffect

public com.icesoft.faces.context.effects.Effect getOnkeydowneffect()

Return the value of the onkeydowneffect property.

setOnkeydowneffect

public void setOnkeydowneffect(com.icesoft.faces.context.effects.Effect onkeydowneffect)

Set the value of the onkeydowneffect property.

getOnkeyupeffect

public com.icesoft.faces.context.effects.Effect getOnkeyupeffect()

Return the value of the onkeyupeffect property.

setOnkeyupeffect

public void setOnkeyupeffect(com.icesoft.faces.context.effects.Effect onkeyupeffect)

Set the value of the onkeyupeffect property.

getCurrentStyle

public com.icesoft.faces.context.effects.CurrentStyle getCurrentStyle()

Return the value of the currentStyle property.

setCurrentStyle

public void setCurrentStyle(com.icesoft.faces.context.effects.CurrentStyle currentStyle)

Set the value of the currentStyle property.

setStyleClass

public void setStyleClass(java.lang.String styleClass)

Set the value of the styleClass property.

Overrides:

setStyleClass in class javax.faces.component.html.HtmlGraphicImage

getStyleClass

public java.lang.String getStyleClass()

Return the value of the styleClass property.

Overrides:

getStyleClass in class javax.faces.component.html.HtmlGraphicImage

setMimeType

public void setMimeType(java.lang.String mimeType)

getMimeType

public java.lang.String getMimeType()

saveState

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

Gets the state of the instance as a Serializable Object.

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class javax.faces.component.UIComponentBase

restoreState

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

Perform any processing required to restore the state from the entries in the state Object.

Specified by:

restoreState in interface javax.faces.component.StateHolder

Overrides:

restoreState in class javax.faces.component.UIComponentBase

getByteArrayImagePath

public java.lang.String getByteArrayImagePath(javax.faces.context.FacesContext context)