org.rcfaces.core.component
Class UIImageItemComponent

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UISelectItem
              org.rcfaces.core.internal.component.CameliaItemComponent
                  org.rcfaces.core.component.AbstractItemComponent
                      org.rcfaces.core.component.SelectItemComponent
                          org.rcfaces.core.component.UIImageItemComponent

All Implemented Interfaces:

StateHolder, IAlternateTextCapability, IClientDataCapability, IDisabledCapability, IImageCapability, IServerDataCapability, IStatesImageCapability, IToolTipCapability, IUnlockedClientAttributesCapability, IVisibilityCapability, org.rcfaces.core.internal.capability.IComponentLifeCycle, 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

Direct Known Subclasses:

ExpandableItemComponent, ToolItemComponent

public class UIImageItemComponent
extends SelectItemComponent
implements IVisibilityCapability, IStatesImageCapability, IAlternateTextCapability, org.rcfaces.core.internal.capability.IImageAccessorsCapability

A select item (member of a selectable list) that shows an image. Ricer than a selectImageItem.

Field Summary

protected static Set	CAMELIA_ATTRIBUTES
static String	COMPONENT_TYPE

Fields inherited from class org.rcfaces.core.internal.component.CameliaItemComponent

engine

Fields inherited from class javax.faces.component.UISelectItem

COMPONENT_FAMILY

Fields inherited from class javax.faces.component.UIComponent

bindings

Constructor Summary

UIImageItemComponent()

UIImageItemComponent(String componentId)

Method Summary

String	getAlternateText()
String	getAlternateText(FacesContext facesContext) See getAlternateText() for more details
protected Set	getCameliaFields()
String	getDisabledImageURL() Returns an url string pointing to the image used for the disabled state.
String	getDisabledImageURL(FacesContext facesContext) See getDisabledImageURL() for more details
String	getHoverImageURL() Returns an url string pointing to the image used chen the pointer hover the component.
String	getHoverImageURL(FacesContext facesContext) See getHoverImageURL() for more details
IContentAccessors	getImageAccessors() Returns ImageAccessors associated to the url.
IContentAccessors	getImageAccessors(FacesContext facesContext)
String	getImageURL() Returns the URL of the image.
String	getImageURL(FacesContext facesContext) See getImageURL() for more details
String	getSelectedImageURL() Returns an url string pointing to the image used when the component is selected.
String	getSelectedImageURL(FacesContext facesContext) See getSelectedImageURL() for more details
Boolean	getVisibleState() Returns TRUE if the receiver is visible, FALSE if the receiver is specified "not visible", and null otherwise.
Boolean	getVisibleState(FacesContext facesContext)
boolean	isAlternateTextSetted() Returns true if the attribute "alternateText" is set.
boolean	isDisabledImageURLSetted() Returns true if the attribute "disabledImageURL" is set.
boolean	isHoverImageURLSetted() Returns true if the attribute "hoverImageURL" is set.
boolean	isImageURLSetted() Returns true if the attribute "imageURL" is set.
boolean	isSelectedImageURLSetted() Returns true if the attribute "selectedImageURL" is set.
boolean	isVisible()
boolean	isVisible(FacesContext facesContext) See isVisible() for more details
boolean	isVisibleSetted() Returns true if the attribute "visible" is set.
void	setAlternateText(String alternateText)
void	setDisabledImageURL(String disabledImageURL) Sets an url string pointing to the image used for the disabled state.
void	setHoverImageURL(String hoverImageURL) Sets an url string pointing to the image used chen the pointer hover the component.
void	setImageURL(String imageURL) Specify the URL of the image.
void	setSelectedImageURL(String selectedImageURL) Sets an url string pointing to the image used when the component is selected.
void	setVisible(boolean visible) Marks the receiver as visible if the argument is TRUE, and marks it invisible if argument is FALSE.

Methods inherited from class org.rcfaces.core.component.SelectItemComponent

getToolTip, getToolTipText, getToolTipText, isToolTipTextSetted, setToolTip, setToolTipText, setValueExpression

Methods inherited from class org.rcfaces.core.component.AbstractItemComponent

getClientData, getClientData, getClientDataCount, getClientDataMap, getClientDataMap, getServerData, getServerData, getServerDataCount, getServerDataMap, getServerDataMap, getUnlockedClientAttributeNames, getUnlockedClientAttributeNames, isDisabled, isDisabledSetted, isUnlockedClientAttributeNamesSetted, listClientDataKeys, listClientDataKeys, listServerDataKeys, listServerDataKeys, removeClientData, removeServerData, setClientData, setClientData, setDisabled, setServerData, setServerData, setUnlockedClientAttributeNames

Methods inherited from class org.rcfaces.core.internal.component.CameliaItemComponent

clearListeners, confirmListenerAppend, constructPhase, constructTemplate, decodePhase, encodeBegin, encodeChildren, encodeEnd, getAsyncRenderer, getCameliaValueAlias, getChildren, getChildrenListState, getFamily, getRendererType, getTransientAttribute, getValueExpression, hasDefaultProperties, initializeComponent, initializePhase, isClientRendered, isRendered, isTemplateComponent, processDecodes, processEngineUpdates, processEngineValidators, processUpdates, processValidators, queueEvent, renderPhase, restoreState, saveState, setDefaultProperties, setRendered, setTransientAttribute, toString, updatePhase, validationPhase, verifyAsyncDecode

Methods inherited from class javax.faces.component.UISelectItem

getItemDescription, getItemLabel, getItemValue, getValue, isItemDisabled, isItemEscaped, setItemDescription, setItemDisabled, setItemEscaped, setItemLabel, setItemValue, 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

Field Detail

COMPONENT_TYPE

public static final String COMPONENT_TYPE

See Also:

Constant Field Values

CAMELIA_ATTRIBUTES

protected static final Set CAMELIA_ATTRIBUTES

Constructor Detail

UIImageItemComponent

public UIImageItemComponent()

UIImageItemComponent

public UIImageItemComponent(String componentId)

Method Detail

getImageAccessors

public IContentAccessors getImageAccessors(FacesContext facesContext)

Specified by:

getImageAccessors in interface org.rcfaces.core.internal.capability.IImageAccessorsCapability

getVisibleState

public Boolean getVisibleState(FacesContext facesContext)

isVisible

public boolean isVisible()

Specified by:

isVisible in interface IVisibilityCapability

isVisible

public boolean isVisible(FacesContext facesContext)

See isVisible() for more details

isVisibleSetted

public final boolean isVisibleSetted()

Returns true if the attribute "visible" is set.

Returns:

true if the attribute is set.

setVisible

public void setVisible(boolean visible)

Description copied from interface: IVisibilityCapability

Marks the receiver as visible if the argument is TRUE, and marks it invisible if argument is FALSE.
If one of the receiver's ancestors is not visible or some other condition makes the receiver not visible, marking it visible may not actually cause it to be displayed.

Specified by:

setVisible in interface IVisibilityCapability

Parameters:

visible - the new visibility state.

getVisibleState

public Boolean getVisibleState()

Description copied from interface: IVisibilityCapability

Returns TRUE if the receiver is visible, FALSE if the receiver is specified "not visible", and null otherwise.
If one of the receiver's ancestors is not visible or some other condition makes the receiver not visible, this method may still indicate that it is considered visible even though it may not actually be showing.

Specified by:

getVisibleState in interface IVisibilityCapability

Returns:

the receiver's visibility state

getDisabledImageURL

public String getDisabledImageURL()

Description copied from interface: IStatesImageCapability

Returns an url string pointing to the image used for the disabled state.

Specified by:

getDisabledImageURL in interface IStatesImageCapability

Returns:

url

getDisabledImageURL

public String getDisabledImageURL(FacesContext facesContext)

See getDisabledImageURL() for more details

isDisabledImageURLSetted

public final boolean isDisabledImageURLSetted()

Returns true if the attribute "disabledImageURL" is set.

Returns:

true if the attribute is set.

setDisabledImageURL

public void setDisabledImageURL(String disabledImageURL)

Description copied from interface: IStatesImageCapability

Sets an url string pointing to the image used for the disabled state.

Specified by:

setDisabledImageURL in interface IStatesImageCapability

Parameters:

disabledImageURL - url

getHoverImageURL

public String getHoverImageURL()

Description copied from interface: IStatesImageCapability

Returns an url string pointing to the image used chen the pointer hover the component.

Specified by:

getHoverImageURL in interface IStatesImageCapability

Returns:

url

getHoverImageURL

public String getHoverImageURL(FacesContext facesContext)

See getHoverImageURL() for more details

isHoverImageURLSetted

public final boolean isHoverImageURLSetted()

Returns true if the attribute "hoverImageURL" is set.

Returns:

true if the attribute is set.

setHoverImageURL

public void setHoverImageURL(String hoverImageURL)

Description copied from interface: IStatesImageCapability

Sets an url string pointing to the image used chen the pointer hover the component.

Specified by:

setHoverImageURL in interface IStatesImageCapability

Parameters:

hoverImageURL - url

getSelectedImageURL

public String getSelectedImageURL()

Description copied from interface: IStatesImageCapability

Returns an url string pointing to the image used when the component is selected.

Specified by:

getSelectedImageURL in interface IStatesImageCapability

Returns:

url

getSelectedImageURL

public String getSelectedImageURL(FacesContext facesContext)

See getSelectedImageURL() for more details

isSelectedImageURLSetted

public final boolean isSelectedImageURLSetted()

Returns true if the attribute "selectedImageURL" is set.

Returns:

true if the attribute is set.

setSelectedImageURL

public void setSelectedImageURL(String selectedImageURL)

Description copied from interface: IStatesImageCapability

Sets an url string pointing to the image used when the component is selected.

Specified by:

setSelectedImageURL in interface IStatesImageCapability

Parameters:

selectedImageURL - url

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.

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

getCameliaFields

protected Set getCameliaFields()

Overrides:

getCameliaFields in class SelectItemComponent