public abstract class PartialRichDocument
extends org.apache.myfaces.trinidad.component.UIXDocument
implements javax.faces.component.behavior.ClientBehaviorHolder
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 |
FAILED_CONNECTION_TEXT_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
INITIAL_FOCUS_ID_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
INLINE_STYLE_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
LARGE_ICON_SOURCE_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
MAXIMIZED_KEY |
static String |
META_CONTAINER_FACET |
static org.apache.myfaces.trinidad.bean.PropertyKey |
ONUNLOAD_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 |
SMALL_ICON_SOURCE_KEY |
static String |
STATE_SAVING_CLIENT |
static String |
STATE_SAVING_DEFAULT |
static org.apache.myfaces.trinidad.bean.PropertyKey |
STATE_SAVING_KEY |
static String |
STATE_SAVING_SERVER |
static org.apache.myfaces.trinidad.bean.PropertyKey |
STYLE_CLASS_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
THEME_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
TITLE_KEY |
static org.apache.myfaces.trinidad.bean.FacesBean.Type |
TYPE |
static org.apache.myfaces.trinidad.bean.PropertyKey |
UNCOMMITTED_DATA_WARNING_KEY |
static String |
UNCOMMITTED_DATA_WARNING_OFF |
static String |
UNCOMMITTED_DATA_WARNING_ON |
static org.apache.myfaces.trinidad.bean.PropertyKey |
UNSECURE_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
VISIBLE_KEY |
Modifier | Constructor and Description |
---|---|
protected |
PartialRichDocument(String rendererType)
Construct an instance of the PartialRichDocument.
|
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 |
getFailedConnectionText()
Gets the text that is displayed in an alert message when the XMLHttpRequest data transfer fails.When this is not set, we log a default message to the client-side error console.
|
String |
getFamily() |
String |
getInitialFocusId()
Gets the id of the component that you want to have focus when the full page renders.
|
String |
getInlineStyle()
Gets the CSS styles to use for this component.
|
String |
getLargeIconSource()
Gets Specifies a large icon that the browser may use when bookmarking this page to your device's home screen.
|
javax.faces.component.UIComponent |
getMetaContainer()
Content to be rendered as meta data inside the "head" section.
|
String |
getOnunload()
Gets an onunload Javascript handler.
|
String[] |
getPartialTriggers()
Gets the IDs of the components that should trigger a partial update.
|
String |
getShortDesc()
Gets the short description of the component.
|
String |
getSmallIconSource()
Gets Specifies a small icon that the browser may insert into the address bar (commonly known as a "favicon").
|
String |
getStateSaving()
Gets Specify the state saving behavior for this page.
|
String |
getStyleClass()
Gets a CSS style class to use for this component.
|
String |
getTheme()
Gets The component style theme to apply to this component.
|
String |
getTitle()
Gets the title of the document.
|
String |
getUncommittedDataWarning()
Gets Specifies whether users should be warned about uncommitted data when navigating off the page.
|
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 |
isMaximized()
Gets an attribute which if set to "true" (the default) will cause the page's outer-most margin and padding collapse to 0px.
|
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 |
setFailedConnectionText(String failedConnectionText)
Sets the text that is displayed in an alert message when the XMLHttpRequest data transfer fails.When this is not set, we log a default message to the client-side error console.
|
void |
setInitialFocusId(String initialFocusId)
Sets the id of the component that you want to have focus when the full page renders.
|
void |
setInlineStyle(String inlineStyle)
Sets the CSS styles to use for this component.
|
void |
setLargeIconSource(String largeIconSource)
Sets Specifies a large icon that the browser may use when bookmarking this page to your device's home screen.
|
void |
setMaximized(boolean maximized)
Sets an attribute which if set to "true" (the default) will cause the page's outer-most margin and padding collapse to 0px.
|
void |
setMetaContainer(javax.faces.component.UIComponent metaContainerFacet)
Content to be rendered as meta data inside the "head" section.
|
void |
setOnunload(String onunload)
Sets an onunload Javascript handler.
|
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 component.
|
void |
setSmallIconSource(String smallIconSource)
Sets Specifies a small icon that the browser may insert into the address bar (commonly known as a "favicon").
|
void |
setStateSaving(String stateSaving)
Sets Specify the state saving behavior for this page.
|
void |
setStyleClass(String styleClass)
Sets a CSS style class to use for this component.
|
void |
setTheme(String theme)
Sets The component style theme to apply to this component.
|
void |
setTitle(String title)
Sets the title of the document.
|
void |
setUncommittedDataWarning(String uncommittedDataWarning)
Sets Specifies whether users should be warned about uncommitted data when navigating off the page.
|
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.
|
setupVisitingContext, tearDownVisitingContext
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, tearDownChildrenEncodingContext, tearDownChildrenVisitingContext, tearDownEncodingContext, visitAllChildren, visitChildren, visitChildren, visitTree, visitTree
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getPassThroughAttributes, getResourceBundleMap, getTransientStateHelper, getTransientStateHelper, isCompositeComponent, isInView, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView
public static final String STATE_SAVING_DEFAULT
public static final String STATE_SAVING_CLIENT
public static final String STATE_SAVING_SERVER
public static final String UNCOMMITTED_DATA_WARNING_ON
public static final String UNCOMMITTED_DATA_WARNING_OFF
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 THEME_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey TITLE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey STATE_SAVING_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey ONUNLOAD_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey INITIAL_FOCUS_ID_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey FAILED_CONNECTION_TEXT_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey MAXIMIZED_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey UNCOMMITTED_DATA_WARNING_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey SMALL_ICON_SOURCE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey LARGE_ICON_SOURCE_KEY
public static final String META_CONTAINER_FACET
public static final String COMPONENT_FAMILY
public static final String COMPONENT_TYPE
protected PartialRichDocument(String rendererType)
public final javax.faces.component.UIComponent getMetaContainer()
public final void setMetaContainer(javax.faces.component.UIComponent metaContainerFacet)
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()
For components with images, the shortDesc is often used to render an HTML alt attribute for the image. Please see the accessibility guidelines section for correct alt text usage of the shortDesc attribute.
shortDesc is also commonly used to render an HTML title attribute, which is used by user agents to display tooltip help text. In this case the behavior for the tooltip is controlled by the user agent, e.g. Firefox 2 truncates long tooltips. For form components, the shortDesc is displayed in a note window. For components that support the helpTopicId attribute and are not using the shortDesc as image alt text, it is recommended that helpTopicId is used instead of shortDesc as it is more flexible and provides more accessible descriptive text than the use of the title attribute.
public final void setShortDesc(String shortDesc)
For components with images, the shortDesc is often used to render an HTML alt attribute for the image. Please see the accessibility guidelines section for correct alt text usage of the shortDesc attribute.
shortDesc is also commonly used to render an HTML title attribute, which is used by user agents to display tooltip help text. In this case the behavior for the tooltip is controlled by the user agent, e.g. Firefox 2 truncates long tooltips. For form components, the shortDesc is displayed in a note window. For components that support the helpTopicId attribute and are not using the shortDesc as image alt text, it is recommended that helpTopicId is used instead of shortDesc as it is more flexible and provides more accessible descriptive text than the use of the title attribute.
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 getTheme()
public final void setTheme(String theme)
theme
- the new theme valuepublic final String getTitle()
public final void setTitle(String title)
title
- the new title valuepublic final String getStateSaving()
public final void setStateSaving(String stateSaving)
stateSaving
- the new stateSaving valuepublic final String getOnunload()
public final void setOnunload(String onunload)
onunload
- the new onunload valuepublic final String getInitialFocusId()
Identifiers are relative to the component, and must account for NamingContainers. You can use a single colon to start the search from the root, or multiple colons to move up through the NamingContainers - "::" will pop out of the component's naming container and begin the search from there, ":::" will pop out of two naming containers and begin the search from there, etc.
public final void setInitialFocusId(String initialFocusId)
Identifiers are relative to the component, and must account for NamingContainers. You can use a single colon to start the search from the root, or multiple colons to move up through the NamingContainers - "::" will pop out of the component's naming container and begin the search from there, ":::" will pop out of two naming containers and begin the search from there, etc.
initialFocusId
- the new initialFocusId valuepublic final String getFailedConnectionText()
public final void setFailedConnectionText(String failedConnectionText)
failedConnectionText
- the new failedConnectionText valuepublic final boolean isMaximized()
public final void setMaximized(boolean maximized)
maximized
- the new maximized valuepublic final String getUncommittedDataWarning()
public final void setUncommittedDataWarning(String uncommittedDataWarning)
uncommittedDataWarning
- the new uncommittedDataWarning valuepublic final String getSmallIconSource()
public final void setSmallIconSource(String smallIconSource)
smallIconSource
- the new smallIconSource valuepublic final String getLargeIconSource()
public final void setLargeIconSource(String largeIconSource)
largeIconSource
- the new largeIconSource 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.UIXDocument
protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
getBeanType
in class org.apache.myfaces.trinidad.component.UIXDocument