org.apache.myfaces.component.html.ext
Class HtmlGraphicImage

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UIGraphic
              javax.faces.component.html.HtmlGraphicImage
                  org.apache.myfaces.component.html.ext.AbstractHtmlGraphicImage
                      org.apache.myfaces.component.html.ext.HtmlGraphicImage

All Implemented Interfaces:

EventListener, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, AlignProperty, ForceIdAware, UserRoleAware

public class HtmlGraphicImage
extends AbstractHtmlGraphicImage

Nested Class Summary

protected static class

HtmlGraphicImage.PropertyKeys

Field Summary

static String	COMPONENT_FAMILY
static String	COMPONENT_TYPE
static String	DEFAULT_RENDERER_TYPE

Fields inherited from class javax.faces.component.UIComponent

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

Fields inherited from interface org.apache.myfaces.component.UserRoleAware

ENABLED_ON_USER_ROLE_ATTR, VISIBLE_ON_USER_ROLE_ATTR

Constructor Summary

HtmlGraphicImage()

Method Summary

String	getAlign() HTML: Specifies the horizontal alignment of this element.
String	getBorder() HTML: Specifies the width of the border of this element, in pixels.
String	getEnabledOnUserRole() If user is in given role, this component will be rendered normally.
String	getFamily()
String	getHspace() HTML: The amount of white space to be inserted to the left and right of this element, in undefined units.
String	getVisibleOnUserRole() If user is in given role, this component will be rendered normally.
String	getVspace() HTML: The amount of white space to be inserted above and below this element, in undefined units.
boolean	isForceId() If true, this component will force the use of the specified id when rendering.
boolean	isForceIdIndex() If false, this component will not append a '[n]' suffix (where 'n' is the row index) to components that are contained within a "list." This value will be true by default and the value will be ignored if the value of forceId is false (or not specified.)
void	setAlign(String align)
void	setBorder(String border)
void	setEnabledOnUserRole(String enabledOnUserRole)
void	setForceId(boolean forceId)
void	setForceIdIndex(boolean forceIdIndex)
void	setHspace(String hspace)
void	setVisibleOnUserRole(String visibleOnUserRole)
void	setVspace(String vspace)

Methods inherited from class org.apache.myfaces.component.html.ext.AbstractHtmlGraphicImage

getClientId, isRendered

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

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

Methods inherited from class javax.faces.component.UIGraphic

getUrl, getValue, getValueExpression, setUrl, setValue, setValueExpression

Methods inherited from class javax.faces.component.UIComponentBase

addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getDefaultEventName, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, initialStateMarked, invokeOnComponent, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, visitTree

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, setInView, subscribeToEvent, unsubscribeFromEvent

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

Field Detail

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY

See Also:

Constant Field Values

COMPONENT_TYPE

public static final String COMPONENT_TYPE

See Also:

Constant Field Values

DEFAULT_RENDERER_TYPE

public static final String DEFAULT_RENDERER_TYPE

See Also:

Constant Field Values

Constructor Detail

HtmlGraphicImage

public HtmlGraphicImage()

Method Detail

getFamily

public String getFamily()

Overrides:

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

getBorder

public String getBorder()

Description copied from class: AbstractHtmlGraphicImage

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

Specified by:

getBorder in class AbstractHtmlGraphicImage

setBorder

public void setBorder(String border)

getHspace

public String getHspace()

Description copied from class: AbstractHtmlGraphicImage

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 AbstractHtmlGraphicImage

setHspace

public void setHspace(String hspace)

getVspace

public String getVspace()

Description copied from class: AbstractHtmlGraphicImage

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 AbstractHtmlGraphicImage

setVspace

public void setVspace(String vspace)

getEnabledOnUserRole

public String getEnabledOnUserRole()

Description copied from interface: UserRoleAware

If user is in given role, this component will be rendered normally. If not, no hyperlink is rendered but all nested tags (=body) are rendered.

Returns:

setEnabledOnUserRole

public void setEnabledOnUserRole(String enabledOnUserRole)

getVisibleOnUserRole

public String getVisibleOnUserRole()

Description copied from interface: UserRoleAware

If user is in given role, this component will be rendered normally. If not, nothing is rendered and the body of this tag will be skipped.

Returns:

setVisibleOnUserRole

public void setVisibleOnUserRole(String visibleOnUserRole)

isForceId

public boolean isForceId()

Description copied from interface: ForceIdAware

If true, this component will force the use of the specified id when rendering.

Returns:

setForceId

public void setForceId(boolean forceId)

isForceIdIndex

public boolean isForceIdIndex()

Description copied from interface: ForceIdAware

If false, this component will not append a '[n]' suffix (where 'n' is the row index) to components that are contained within a "list." This value will be true by default and the value will be ignored if the value of forceId is false (or not specified.)

Returns:

setForceIdIndex

public void setForceIdIndex(boolean forceIdIndex)

getAlign

public String getAlign()

Description copied from interface: AlignProperty

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

setAlign

public void setAlign(String align)