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

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by javax.faces.component.UIGraphic
              extended by javax.faces.component.html.HtmlGraphicImage
                  extended by org.apache.myfaces.component.html.ext.AbstractHtmlGraphicImage
                      extended by 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
 void addClientBehavior(String eventName, javax.faces.component.behavior.ClientBehavior behavior)
           
 String getAlign()
          HTML: Specifies the horizontal alignment of this element.
 String getAlt()
           
 String getBorder()
          HTML: Specifies the width of the border of this element, in pixels.
 String getDir()
           
 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 getLang()
           
 String getOnclick()
           
 String getOndblclick()
           
 String getOnkeydown()
           
 String getOnkeypress()
           
 String getOnkeyup()
           
 String getOnmousedown()
           
 String getOnmousemove()
           
 String getOnmouseout()
           
 String getOnmouseover()
           
 String getOnmouseup()
           
 String getStyle()
           
 String getStyleClass()
           
 String getTitle()
           
 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 setAlt(String alt)
           
 void setBorder(String border)
           
 void setDir(String dir)
           
 void setEnabledOnUserRole(String enabledOnUserRole)
           
 void setForceId(boolean forceId)
           
 void setForceIdIndex(boolean forceIdIndex)
           
 void setHspace(String hspace)
           
 void setLang(String lang)
           
 void setOnclick(String onclick)
           
 void setOndblclick(String ondblclick)
           
 void setOnkeydown(String onkeydown)
           
 void setOnkeypress(String onkeypress)
           
 void setOnkeyup(String onkeyup)
           
 void setOnmousedown(String onmousedown)
           
 void setOnmousemove(String onmousemove)
           
 void setOnmouseout(String onmouseout)
           
 void setOnmouseover(String onmouseover)
           
 void setOnmouseup(String onmouseup)
           
 void setStyle(String style)
           
 void setStyleClass(String styleClass)
           
 void setTitle(String title)
           
 void setValueBinding(String name, javax.faces.el.ValueBinding binding)
           
 void setValueExpression(String name, javax.el.ValueExpression expression)
           
 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
getEventNames, getHeight, getLongdesc, getUsemap, getWidth, isIsmap, setHeight, setIsmap, setLongdesc, setUsemap, setWidth
 
Methods inherited from class javax.faces.component.UIGraphic
getUrl, getValue, getValueExpression, setUrl, setValue
 
Methods inherited from class javax.faces.component.UIComponentBase
addFacesListener, broadcast, clearInitialState, decode, encodeAll, 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, visitTree
 
Methods inherited from class javax.faces.component.UIComponent
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
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

addClientBehavior

public void addClientBehavior(String eventName,
                              javax.faces.component.behavior.ClientBehavior behavior)
Specified by:
addClientBehavior in interface javax.faces.component.behavior.ClientBehaviorHolder
Overrides:
addClientBehavior 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)

getStyle

public String getStyle()
Overrides:
getStyle in class javax.faces.component.html.HtmlGraphicImage

setStyle

public void setStyle(String style)
Overrides:
setStyle in class javax.faces.component.html.HtmlGraphicImage

getStyleClass

public String getStyleClass()
Overrides:
getStyleClass in class javax.faces.component.html.HtmlGraphicImage

setStyleClass

public void setStyleClass(String styleClass)
Overrides:
setStyleClass in class javax.faces.component.html.HtmlGraphicImage

getAlt

public String getAlt()
Overrides:
getAlt in class javax.faces.component.html.HtmlGraphicImage

setAlt

public void setAlt(String alt)
Overrides:
setAlt in class javax.faces.component.html.HtmlGraphicImage

getOnclick

public String getOnclick()
Overrides:
getOnclick in class javax.faces.component.html.HtmlGraphicImage

setOnclick

public void setOnclick(String onclick)
Overrides:
setOnclick in class javax.faces.component.html.HtmlGraphicImage

getOndblclick

public String getOndblclick()
Overrides:
getOndblclick in class javax.faces.component.html.HtmlGraphicImage

setOndblclick

public void setOndblclick(String ondblclick)
Overrides:
setOndblclick in class javax.faces.component.html.HtmlGraphicImage

getOnkeydown

public String getOnkeydown()
Overrides:
getOnkeydown in class javax.faces.component.html.HtmlGraphicImage

setOnkeydown

public void setOnkeydown(String onkeydown)
Overrides:
setOnkeydown in class javax.faces.component.html.HtmlGraphicImage

getOnkeypress

public String getOnkeypress()
Overrides:
getOnkeypress in class javax.faces.component.html.HtmlGraphicImage

setOnkeypress

public void setOnkeypress(String onkeypress)
Overrides:
setOnkeypress in class javax.faces.component.html.HtmlGraphicImage

getOnkeyup

public String getOnkeyup()
Overrides:
getOnkeyup in class javax.faces.component.html.HtmlGraphicImage

setOnkeyup

public void setOnkeyup(String onkeyup)
Overrides:
setOnkeyup in class javax.faces.component.html.HtmlGraphicImage

getOnmousedown

public String getOnmousedown()
Overrides:
getOnmousedown in class javax.faces.component.html.HtmlGraphicImage

setOnmousedown

public void setOnmousedown(String onmousedown)
Overrides:
setOnmousedown in class javax.faces.component.html.HtmlGraphicImage

getOnmousemove

public String getOnmousemove()
Overrides:
getOnmousemove in class javax.faces.component.html.HtmlGraphicImage

setOnmousemove

public void setOnmousemove(String onmousemove)
Overrides:
setOnmousemove in class javax.faces.component.html.HtmlGraphicImage

getOnmouseout

public String getOnmouseout()
Overrides:
getOnmouseout in class javax.faces.component.html.HtmlGraphicImage

setOnmouseout

public void setOnmouseout(String onmouseout)
Overrides:
setOnmouseout in class javax.faces.component.html.HtmlGraphicImage

getOnmouseover

public String getOnmouseover()
Overrides:
getOnmouseover in class javax.faces.component.html.HtmlGraphicImage

setOnmouseover

public void setOnmouseover(String onmouseover)
Overrides:
setOnmouseover in class javax.faces.component.html.HtmlGraphicImage

getOnmouseup

public String getOnmouseup()
Overrides:
getOnmouseup in class javax.faces.component.html.HtmlGraphicImage

setOnmouseup

public void setOnmouseup(String onmouseup)
Overrides:
setOnmouseup in class javax.faces.component.html.HtmlGraphicImage

getDir

public String getDir()
Overrides:
getDir in class javax.faces.component.html.HtmlGraphicImage

setDir

public void setDir(String dir)
Overrides:
setDir in class javax.faces.component.html.HtmlGraphicImage

getLang

public String getLang()
Overrides:
getLang in class javax.faces.component.html.HtmlGraphicImage

setLang

public void setLang(String lang)
Overrides:
setLang in class javax.faces.component.html.HtmlGraphicImage

getTitle

public String getTitle()
Overrides:
getTitle in class javax.faces.component.html.HtmlGraphicImage

setTitle

public void setTitle(String title)
Overrides:
setTitle in class javax.faces.component.html.HtmlGraphicImage

setValueBinding

public void setValueBinding(String name,
                            javax.faces.el.ValueBinding binding)
Overrides:
setValueBinding in class javax.faces.component.html.HtmlGraphicImage

setValueExpression

public void setValueExpression(String name,
                               javax.el.ValueExpression expression)
Overrides:
setValueExpression in class javax.faces.component.html.HtmlGraphicImage


Copyright © 2012 The Apache Software Foundation. All Rights Reserved.