Class UIPage
java.lang.Object
jakarta.faces.component.UIComponent
jakarta.faces.component.UIComponentBase
jakarta.faces.component.UIForm
org.apache.myfaces.tobago.internal.component.AbstractUIFormBase
org.apache.myfaces.tobago.internal.component.AbstractUIPage
org.apache.myfaces.tobago.component.UIPage
- All Implemented Interfaces:
jakarta.faces.component.behavior.ClientBehaviorHolder
,jakarta.faces.component.NamingContainer
,jakarta.faces.component.PartialStateHolder
,jakarta.faces.component.StateHolder
,jakarta.faces.component.TransientStateHolder
,jakarta.faces.component.UniqueIdVendor
,jakarta.faces.event.ComponentSystemEventListener
,jakarta.faces.event.FacesListener
,jakarta.faces.event.SystemEventListenerHolder
,EventListener
,Visual
Renders a page element.
The markup {
UIComponent class, generated from template component.stg
with class
PageTagDeclaration
.
-
Field Summary
FieldsFields inherited from class org.apache.myfaces.tobago.internal.component.AbstractUIPage
FORM_ACCEPT_CHARSET
Fields inherited from class jakarta.faces.component.UIComponent
ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, FACETS_KEY, VIEW_LOCATION_KEY
Fields inherited from interface jakarta.faces.component.NamingContainer
SEPARATOR_CHAR
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionSets a CSS class in its parent, if the parent supports it.Contains the id of the component which should have the focus after loading the page.getLabel()
A localized user presentable label for this component.void
restoreState
(jakarta.faces.context.FacesContext context, Object state) void
setCustomClass
(CustomClass customClass) void
setFocusId
(String focusId) void
void
Methods inherited from class org.apache.myfaces.tobago.internal.component.AbstractUIPage
cutIteratorFromId, getFormId, getRendersChildren, markSubmittedForm, processDecodes
Methods inherited from class org.apache.myfaces.tobago.internal.component.AbstractUIFormBase
processUpdates, processValidators, setSubmitted
Methods inherited from class jakarta.faces.component.UIForm
createUniqueId, getContainerClientId, invokeOnComponent, isPrependId, isSubmitted, setPrependId, visitTree
Methods inherited from class jakarta.faces.component.UIComponentBase
addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getPassThroughAttributes, getRenderer, getRendererType, isRendered, isTransient, markInitialState, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient
Methods inherited from class jakarta.faces.component.UIComponent
getClientId, getCompositeComponentParent, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, subscribeToEvent, unsubscribeFromEvent
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface jakarta.faces.component.behavior.ClientBehaviorHolder
addClientBehavior, getClientBehaviors
Methods inherited from interface org.apache.myfaces.tobago.component.Visual
getRendererType, isPlain
-
Field Details
-
COMPONENT_TYPE
-
COMPONENT_FAMILY
- See Also:
-
-
Constructor Details
-
UIPage
public UIPage()
-
-
Method Details
-
getEventNames
- Specified by:
getEventNames
in interfacejakarta.faces.component.behavior.ClientBehaviorHolder
- Overrides:
getEventNames
in classjakarta.faces.component.UIComponentBase
-
getDefaultEventName
- Specified by:
getDefaultEventName
in interfacejakarta.faces.component.behavior.ClientBehaviorHolder
- Overrides:
getDefaultEventName
in classjakarta.faces.component.UIComponentBase
-
getFamily
- Overrides:
getFamily
in classjakarta.faces.component.UIForm
-
getMarkup
-
setMarkup
-
getCustomClass
Sets a CSS class in its parent, if the parent supports it. Which this feature it is possible to put a CSS class name into a component with the <tc:style> tag. Example:<tc:in> <tc:style customClass="my-emphasized"/> </tc:in>
One capability is, to used external CSS libs.
This feature should not be used imprudent. Because it might be unstable against changes in the renderered HTML code. -
setCustomClass
-
getLabel
A localized user presentable label for this component.- Specified by:
getLabel
in classAbstractUIPage
-
setLabel
-
getFocusId
Contains the id of the component which should have the focus after loading the page. Set to empty string for disabling setting of focus. Default (null) enables the "auto focus" feature.- Specified by:
getFocusId
in classAbstractUIPage
-
setFocusId
-
restoreState
- Specified by:
restoreState
in interfacejakarta.faces.component.StateHolder
- Overrides:
restoreState
in classjakarta.faces.component.UIComponentBase
-