public class RichActiveImage
extends org.apache.myfaces.trinidad.component.UIXObject
implements javax.faces.component.behavior.ClientBehaviorHolder
The image component renders an image specified by the source property. Due to performance overhead compared to <af:image>
, you should only use this component if you plan to support changing the source attribute through active data, otherwise you should use the <af:image>
component.
Type | Phases | Description |
---|---|---|
org.apache.myfaces.trinidad.event.AttributeChangeEvent |
Invoke Application Apply Request Values |
Event delivered to describe an attribute change. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change event might include the width of a column that supported client-side resizing. |
Modifier and Type | Field and Description |
---|---|
static org.apache.myfaces.trinidad.bean.PropertyKey |
CLIENT_ATTRIBUTES_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
CLIENT_COMPONENT_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
CLIENT_LISTENERS_KEY |
static String |
COMPONENT_FAMILY |
static String |
COMPONENT_TYPE |
static org.apache.myfaces.trinidad.bean.PropertyKey |
CUSTOMIZATION_ID_KEY
Deprecated.
|
static org.apache.myfaces.trinidad.bean.PropertyKey |
IMAGE_MAP_TYPE_KEY |
static String |
IMAGE_MAP_TYPE_NONE |
static String |
IMAGE_MAP_TYPE_SERVER |
static org.apache.myfaces.trinidad.bean.PropertyKey |
INLINE_STYLE_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
LONG_DESC_URL_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
PARTIAL_TRIGGERS_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
SHORT_DESC_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
SOURCE_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
STYLE_CLASS_KEY |
static org.apache.myfaces.trinidad.bean.FacesBean.Type |
TYPE |
static org.apache.myfaces.trinidad.bean.PropertyKey |
UNSECURE_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
VISIBLE_KEY |
Modifier | Constructor and Description |
---|---|
|
RichActiveImage()
Construct an instance of the RichActiveImage.
|
protected |
RichActiveImage(String rendererType)
Construct an instance of the RichActiveImage.
|
Modifier and Type | Method and Description |
---|---|
void |
addClientBehavior(String eventName, javax.faces.component.behavior.ClientBehavior behavior) |
protected org.apache.myfaces.trinidad.bean.FacesBean.Type |
getBeanType() |
Set |
getClientAttributes()
Gets a set of client attribute names.
|
Map<String,List<javax.faces.component.behavior.ClientBehavior>> |
getClientBehaviors() |
ClientListenerSet |
getClientListeners()
Gets a set of client listeners.
|
String |
getCustomizationId()
Deprecated.
This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.
|
String |
getDefaultEventName() |
Collection<String> |
getEventNames() |
String |
getFamily() |
String |
getImageMapType()
Gets if a server-side image map is desired, specify "server" and place the image inside a CoreGoLink component.
|
String |
getInlineStyle()
Gets the CSS styles to use for this component.
|
String |
getLongDescURL()
Gets a URL to a document that contains a long description of the image.
|
String[] |
getPartialTriggers()
Gets the IDs of the components that should trigger a partial update.
|
String |
getShortDesc()
Gets the short description of the activeImage component.
|
String |
getSource()
Gets the URI specifying the location of the image resource.
|
String |
getStyleClass()
Gets a CSS style class to use for this component.
|
Set<String> |
getUnsecure()
Gets A whitespace separated list of attributes whose values ordinarily can be set only on the server, but need to be settable on the client.
|
boolean |
isClientComponent()
Gets whether a client-side component will be generated.
|
boolean |
isVisible()
Gets the visibility of the component.
|
void |
setClientAttributes(Set clientAttributes)
Sets a set of client attribute names.
|
void |
setClientComponent(boolean clientComponent)
Sets whether a client-side component will be generated.
|
void |
setClientListeners(ClientListenerSet clientListeners)
Sets a set of client listeners.
|
void |
setCustomizationId(String customizationId)
Deprecated.
This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.
|
void |
setImageMapType(String imageMapType)
Sets if a server-side image map is desired, specify "server" and place the image inside a CoreGoLink component.
|
void |
setInlineStyle(String inlineStyle)
Sets the CSS styles to use for this component.
|
void |
setLongDescURL(String longDescURL)
Sets a URL to a document that contains a long description of the image.
|
void |
setPartialTriggers(String[] partialTriggers)
Sets the IDs of the components that should trigger a partial update.
|
void |
setShortDesc(String shortDesc)
Sets the short description of the activeImage component.
|
void |
setSource(String source)
Sets the URI specifying the location of the image resource.
|
void |
setStyleClass(String styleClass)
Sets a CSS style class to use for this component.
|
void |
setUnsecure(Set<String> unsecure)
Sets A whitespace separated list of attributes whose values ordinarily can be set only on the server, but need to be settable on the client.
|
void |
setVisible(boolean visible)
Sets the visibility of the component.
|
adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addComponentChange, addComponentChange, addComponentChangeFilter, addFacesListener, broadcast, broadcastToMethodBinding, broadcastToMethodExpression, clearCachedClientIds, clearInitialState, createFacesBean, decode, decodeChildren, decodeChildrenImpl, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getComponentChangeFilters, getContainerClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getListenersForEventClass, getParent, getProperty, getPropertyKey, getRenderedFacetsAndChildren, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, initialStateMarked, invokeOnChildrenComponents, invokeOnComponent, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeAttributeChangeListener, removeComponentChangeFilter, removeFacesListener, restoreState, satisfiesPartialTrigger, saveState, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setupFlattenedChildrenContext, setupFlattenedContext, setValueBinding, setValueExpression, subscribeToEvent, tearDownFlattenedChildrenContext, tearDownFlattenedContext, toString, unsubscribeFromEvent, updateChildren, updateChildrenImpl, validateChildren, validateChildrenImpl
addPartialTarget, broadcastInContext, clearCachedClientIds, defaultGetRenderedFacetsAndChildren, encodeFlattenedChild, encodeFlattenedChildren, getLogicalParent, getLogicalParent, getStateHelper, getStateHelper, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setupChildrenEncodingContext, setupChildrenVisitingContext, setupEncodingContext, setUpEncodingContext, setupVisitingContext, tearDownChildrenEncodingContext, tearDownChildrenVisitingContext, tearDownEncodingContext, tearDownVisitingContext, visitAllChildren, visitChildren, visitChildren, visitTree, visitTree
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getResourceBundleMap, getTransientStateHelper, getTransientStateHelper, isCompositeComponent, isInView, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView
public static final String IMAGE_MAP_TYPE_NONE
public static final String IMAGE_MAP_TYPE_SERVER
public static final org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE
public static final org.apache.myfaces.trinidad.bean.PropertyKey INLINE_STYLE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey STYLE_CLASS_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey SHORT_DESC_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey UNSECURE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey VISIBLE_KEY
@Deprecated public static final org.apache.myfaces.trinidad.bean.PropertyKey CUSTOMIZATION_ID_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_COMPONENT_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_ATTRIBUTES_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey PARTIAL_TRIGGERS_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_LISTENERS_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey SOURCE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey LONG_DESC_URL_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey IMAGE_MAP_TYPE_KEY
public static final String COMPONENT_FAMILY
public static final String COMPONENT_TYPE
public RichActiveImage()
protected RichActiveImage(String rendererType)
public final String getInlineStyle()
public final void setInlineStyle(String inlineStyle)
inlineStyle
- the new inlineStyle valuepublic final String getStyleClass()
public final void setStyleClass(String styleClass)
styleClass
- the new styleClass valuepublic final String getShortDesc()
public final void setShortDesc(String shortDesc)
shortDesc
- the new shortDesc valuepublic final Set<String> getUnsecure()
public final void setUnsecure(Set<String> unsecure)
unsecure
- the new unsecure valuepublic final boolean isVisible()
public final void setVisible(boolean visible)
visible
- the new visible value@Deprecated public final String getCustomizationId()
@Deprecated public final void setCustomizationId(String customizationId)
customizationId
- the new customizationId valuepublic final boolean isClientComponent()
public final void setClientComponent(boolean clientComponent)
clientComponent
- the new clientComponent valuepublic final Set getClientAttributes()
public final void setClientAttributes(Set clientAttributes)
clientAttributes
- the new clientAttributes valuepublic final String[] getPartialTriggers()
public final void setPartialTriggers(String[] partialTriggers)
partialTriggers
- the new partialTriggers valuepublic final ClientListenerSet getClientListeners()
public final void setClientListeners(ClientListenerSet clientListeners)
clientListeners
- the new clientListeners valuepublic final String getSource()
public final void setSource(String source)
source
- the new source valuepublic final String getLongDescURL()
public final void setLongDescURL(String longDescURL)
longDescURL
- the new longDescURL valuepublic final String getImageMapType()
public final void setImageMapType(String imageMapType)
imageMapType
- the new imageMapType valuepublic String getDefaultEventName()
getDefaultEventName
in interface javax.faces.component.behavior.ClientBehaviorHolder
getDefaultEventName
in class org.apache.myfaces.trinidad.component.UIXComponentBase
public Collection<String> getEventNames()
getEventNames
in interface javax.faces.component.behavior.ClientBehaviorHolder
public Map<String,List<javax.faces.component.behavior.ClientBehavior>> getClientBehaviors()
getClientBehaviors
in interface javax.faces.component.behavior.ClientBehaviorHolder
getClientBehaviors
in class org.apache.myfaces.trinidad.component.UIXComponentBase
public void addClientBehavior(String eventName, javax.faces.component.behavior.ClientBehavior behavior)
addClientBehavior
in interface javax.faces.component.behavior.ClientBehaviorHolder
addClientBehavior
in class org.apache.myfaces.trinidad.component.UIXComponentBase
public String getFamily()
getFamily
in class org.apache.myfaces.trinidad.component.UIXObject
protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
getBeanType
in class org.apache.myfaces.trinidad.component.UIXObject