org.rcfaces.core.component
Class ImageComponent

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by javax.faces.component.UIOutput
              extended by org.rcfaces.core.internal.component.CameliaOutputComponent
                  extended by org.rcfaces.core.component.AbstractOutputComponent
                      extended by org.rcfaces.core.component.ImageComponent
All Implemented Interfaces:
StateHolder, ValueHolder, IAlternateTextCapability, IClientDataCapability, IErrorEventCapability, IFilterCapability, IForegroundBackgroundColorCapability, IHeightCapability, IHelpCapability, IHiddenModeCapability, IImageCapability, IImageSizeCapability, IInitEventCapability, ILayoutPositionCapability, ILookAndFeelCapability, IMarginCapability, IMouseEventCapability, IPartialRenderingCapability, IPositionCapability, IPropertyChangeEventCapability, IServerDataCapability, ISizeCapability, IStyleClassCapability, IToolTipCapability, IUnlockedClientAttributesCapability, IUserEventCapability, IValueLockedCapability, IVisibilityCapability, IWAIRoleCapability, IWidthCapability, org.rcfaces.core.internal.capability.IComponentLifeCycle, org.rcfaces.core.internal.capability.IConvertValueHolder, org.rcfaces.core.internal.capability.IImageAccessorsCapability, org.rcfaces.core.internal.capability.IRCFacesComponent, org.rcfaces.core.internal.manager.IClientDataManager, org.rcfaces.core.internal.manager.IContainerManager, org.rcfaces.core.internal.manager.IServerDataManager, org.rcfaces.core.internal.manager.ITransientAttributesManager

public class ImageComponent
extends AbstractOutputComponent
implements IImageCapability, IImageSizeCapability, IAlternateTextCapability, IFilterCapability, org.rcfaces.core.internal.capability.IImageAccessorsCapability

The image Component shows an image (it's equivalent to <img .../>).

The image Component has the following capabilities :

The default image renderer is linked to the f_image javascript class. f_image extends f_filtredComponent

Table of component style classes:

Style Name Description
f_image Defines styles for the wrapper IMG element


Field Summary
protected static Set CAMELIA_ATTRIBUTES
           
protected static String CAMELIA_VALUE_ALIAS
           
static String COMPONENT_TYPE
           
 
Fields inherited from class org.rcfaces.core.internal.component.CameliaOutputComponent
engine
 
Fields inherited from class javax.faces.component.UIOutput
COMPONENT_FAMILY
 
Fields inherited from class javax.faces.component.UIComponent
bindings
 
Fields inherited from interface org.rcfaces.core.component.capability.IHiddenModeCapability
CLIENT_HIDDEN_MODE, DEFAULT_HIDDEN_MODE, IGNORE_HIDDEN_MODE, PHANTOM_HIDDEN_MODE, SERVER_HIDDEN_MODE
 
Constructor Summary
ImageComponent()
           
ImageComponent(String componentId)
           
 
Method Summary
 String getAlternateText()
           
 String getAlternateText(FacesContext facesContext)
          See getAlternateText() for more details
protected  Set getCameliaFields()
           
protected  String getCameliaValueAlias()
           
 IFilterProperties getFilterProperties()
          Return an object that represent the filter to use on the server side.
 IFilterProperties getFilterProperties(FacesContext facesContext)
          See getFilterProperties() for more details
 IContentAccessors getImageAccessors()
          Returns ImageAccessors associated to the url.
 IContentAccessors getImageAccessors(FacesContext facesContext)
           
 int getImageHeight()
          Returns an int value specifying the height (in pixels) to use for the image shown.
 int getImageHeight(FacesContext facesContext)
          See getImageHeight() for more details
 String getImageURL()
          Returns the URL of the image.
 String getImageURL(FacesContext facesContext)
          See getImageURL() for more details
 int getImageWidth()
          Returns an int value specifying the width (in pixels) to use for the image shown.
 int getImageWidth(FacesContext facesContext)
          See getImageWidth() for more details
 boolean isAlternateTextSetted()
          Returns true if the attribute "alternateText" is set.
 boolean isFilterPropertiesSetted()
          Returns true if the attribute "filterProperties" is set.
 boolean isImageHeightSetted()
          Returns true if the attribute "imageHeight" is set.
 boolean isImageURLSetted()
          Returns true if the attribute "imageURL" is set.
 boolean isImageWidthSetted()
          Returns true if the attribute "imageWidth" is set.
 void setAlternateText(String alternateText)
           
 void setFilterProperties(IFilterProperties filterProperties)
          Sets an object that represent the filter to use on the server side.
 void setFilterProperties(String properties)
           
 void setImageHeight(int imageHeight)
          Sets an int value specifying the height (in pixels) to use for the image shown.
 void setImageURL(String imageURL)
          Specify the URL of the image.
 void setImageWidth(int imageWidth)
          Sets an int value specifying the width (in pixels) to use for the image shown.
 
Methods inherited from class org.rcfaces.core.component.AbstractOutputComponent
addErrorListener, addInitListener, addMouseOutListener, addMouseOverListener, addPropertyChangeListener, addUserEventListener, getAriaLabel, getAriaLabel, getAriaLevel, getAriaLevel, getBackgroundColor, getBackgroundColor, getBottom, getBottom, getClientData, getClientData, getClientDataCount, getClientDataMap, getClientDataMap, getForegroundColor, getForegroundColor, getHeight, getHeight, getHelpMessage, getHelpMessage, getHelpURL, getHelpURL, getHiddenMode, getHiddenMode, getLeft, getLeft, getLookId, getLookId, getMarginBottom, getMarginBottom, getMarginLeft, getMarginLeft, getMarginRight, getMarginRight, getMarginTop, getMarginTop, getRight, getRight, getServerData, getServerData, getServerDataCount, getServerDataMap, getServerDataMap, getStyleClass, getStyleClass, getToolTipText, getToolTipText, getTop, getTop, getUnlockedClientAttributeNames, getUnlockedClientAttributeNames, getVisibleState, getVisibleState, getWaiRole, getWaiRole, getWidth, getWidth, getX, getX, getY, getY, isAriaLabelSetted, isAriaLevelSetted, isBackgroundColorSetted, isBottomSetted, isForegroundColorSetted, isHeightSetted, isHelpMessageSetted, isHelpURLSetted, isHiddenModeSetted, isLeftSetted, isLookIdSetted, isMarginBottomSetted, isMarginLeftSetted, isMarginRightSetted, isMarginTopSetted, isPartialRendering, isPartialRendering, isPartialRenderingSetted, isRightSetted, isStyleClassSetted, isToolTipTextSetted, isTopSetted, isUnlockedClientAttributeNamesSetted, isValueLocked, isValueLocked, isValueLockedSetted, isVisible, isVisible, isVisibleSetted, isWaiRoleSetted, isWidthSetted, isXSetted, isYSetted, listClientDataKeys, listClientDataKeys, listErrorListeners, listInitListeners, listMouseOutListeners, listMouseOverListeners, listPropertyChangeListeners, listServerDataKeys, listServerDataKeys, listUserEventListeners, removeClientData, removeErrorListener, removeInitListener, removeMouseOutListener, removeMouseOverListener, removePropertyChangeListener, removeServerData, removeUserEventListener, setAriaLabel, setAriaLevel, setBackgroundColor, setBottom, setClientData, setClientData, setForegroundColor, setHeight, setHelpMessage, setHelpURL, setHiddenMode, setHiddenMode, setLeft, setLookId, setMarginBottom, setMarginLeft, setMarginRight, setMargins, setMarginTop, setPartialRendering, setRight, setServerData, setServerData, setStyleClass, setToolTipText, setTop, setUnlockedClientAttributeNames, setValueLocked, setVisible, setWaiRole, setWidth, setX, setY
 
Methods inherited from class org.rcfaces.core.internal.component.CameliaOutputComponent
clearListeners, confirmListenerAppend, constructPhase, constructTemplate, decodePhase, encodeBegin, encodeChildren, encodeEnd, getAsyncRenderer, getChildren, getChildrenListState, getFamily, getRendererType, getTransientAttribute, getValueExpression, hasDefaultProperties, initializeComponent, initializePhase, isClientRendered, isRendered, isTemplateComponent, processDecodes, processEngineUpdates, processEngineValidators, processUpdates, processValidators, queueEvent, renderPhase, restoreState, saveState, setConverter, setConverter, setDefaultProperties, setRendered, setTransientAttribute, setValueExpression, toString, updatePhase, validationPhase, verifyAsyncDecode
 
Methods inherited from class javax.faces.component.UIOutput
getConverter, getLocalValue, getValue, setConverter, setValue
 
Methods inherited from class javax.faces.component.UIComponentBase
addFacesListener, broadcast, decode, findComponent, getAttributes, getChildCount, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendersChildren, getValueBinding, invokeOnComponent, isTransient, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding
 
Methods inherited from class javax.faces.component.UIComponent
encodeAll, getContainerClientId
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.rcfaces.core.internal.manager.IContainerManager
getChildCount
 
Methods inherited from interface javax.faces.component.ValueHolder
getConverter, getLocalValue, getValue, setConverter, setValue
 

Field Detail

COMPONENT_TYPE

public static final String COMPONENT_TYPE
See Also:
Constant Field Values

CAMELIA_ATTRIBUTES

protected static final Set CAMELIA_ATTRIBUTES

CAMELIA_VALUE_ALIAS

protected static final String CAMELIA_VALUE_ALIAS
See Also:
Constant Field Values
Constructor Detail

ImageComponent

public ImageComponent()

ImageComponent

public ImageComponent(String componentId)
Method Detail

getImageAccessors

public IContentAccessors getImageAccessors(FacesContext facesContext)
Specified by:
getImageAccessors in interface org.rcfaces.core.internal.capability.IImageAccessorsCapability

setFilterProperties

public void setFilterProperties(String properties)

getImageURL

public String getImageURL()
Description copied from interface: IImageCapability
Returns the URL of the image.

Specified by:
getImageURL in interface IImageCapability

getImageURL

public String getImageURL(FacesContext facesContext)
See getImageURL() for more details


isImageURLSetted

public final boolean isImageURLSetted()
Returns true if the attribute "imageURL" is set.

Returns:
true if the attribute is set.

setImageURL

public void setImageURL(String imageURL)
Description copied from interface: IImageCapability
Specify the URL of the image.

Specified by:
setImageURL in interface IImageCapability

getImageAccessors

public IContentAccessors getImageAccessors()
Description copied from interface: IImageCapability
Returns ImageAccessors associated to the url. (or java.awt.Image binding)

Specified by:
getImageAccessors in interface IImageCapability
Returns:
IImageAccessors object.

getImageHeight

public int getImageHeight()
Description copied from interface: IImageSizeCapability
Returns an int value specifying the height (in pixels) to use for the image shown.

Specified by:
getImageHeight in interface IImageSizeCapability
Returns:
image height in pixels

getImageHeight

public int getImageHeight(FacesContext facesContext)
See getImageHeight() for more details


isImageHeightSetted

public final boolean isImageHeightSetted()
Returns true if the attribute "imageHeight" is set.

Returns:
true if the attribute is set.

setImageHeight

public void setImageHeight(int imageHeight)
Description copied from interface: IImageSizeCapability
Sets an int value specifying the height (in pixels) to use for the image shown.

Specified by:
setImageHeight in interface IImageSizeCapability
Parameters:
imageHeight - image height in pixels

getImageWidth

public int getImageWidth()
Description copied from interface: IImageSizeCapability
Returns an int value specifying the width (in pixels) to use for the image shown.

Specified by:
getImageWidth in interface IImageSizeCapability
Returns:
image width in pixels

getImageWidth

public int getImageWidth(FacesContext facesContext)
See getImageWidth() for more details


isImageWidthSetted

public final boolean isImageWidthSetted()
Returns true if the attribute "imageWidth" is set.

Returns:
true if the attribute is set.

setImageWidth

public void setImageWidth(int imageWidth)
Description copied from interface: IImageSizeCapability
Sets an int value specifying the width (in pixels) to use for the image shown.

Specified by:
setImageWidth in interface IImageSizeCapability
Parameters:
imageWidth - image width in pixels

getAlternateText

public String getAlternateText()
Specified by:
getAlternateText in interface IAlternateTextCapability

getAlternateText

public String getAlternateText(FacesContext facesContext)
See getAlternateText() for more details


isAlternateTextSetted

public final boolean isAlternateTextSetted()
Returns true if the attribute "alternateText" is set.

Returns:
true if the attribute is set.

setAlternateText

public void setAlternateText(String alternateText)
Specified by:
setAlternateText in interface IAlternateTextCapability

getFilterProperties

public IFilterProperties getFilterProperties()
Description copied from interface: IFilterCapability
Return an object that represent the filter to use on the server side.

Specified by:
getFilterProperties in interface IFilterCapability
Returns:
filter

getFilterProperties

public IFilterProperties getFilterProperties(FacesContext facesContext)
See getFilterProperties() for more details


isFilterPropertiesSetted

public final boolean isFilterPropertiesSetted()
Returns true if the attribute "filterProperties" is set.

Returns:
true if the attribute is set.

setFilterProperties

public void setFilterProperties(IFilterProperties filterProperties)
Description copied from interface: IFilterCapability
Sets an object that represent the filter to use on the server side.

Specified by:
setFilterProperties in interface IFilterCapability
Parameters:
filterProperties - filter

getCameliaFields

protected Set getCameliaFields()
Overrides:
getCameliaFields in class AbstractOutputComponent

getCameliaValueAlias

protected String getCameliaValueAlias()
Overrides:
getCameliaValueAlias in class org.rcfaces.core.internal.component.CameliaOutputComponent


Copyright © 2006-2011 Vedana. All Rights Reserved.