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 AbstractUIPage
FORM_ACCEPT_CHARSETFields 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_KEYFields 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.Set a CSS class on the component.booleanvoidrestoreState(jakarta.faces.context.FacesContext context, Object state) voidsetCustomClass(CustomClass customClass) voidsetFocusId(String focusId) voidsetIncludeViewParams(boolean includeViewParams) voidvoidvoidsetStyleClass(CustomClass styleClass) Methods inherited from class AbstractUIPage
getFormId, getRendersChildren, markSubmittedForm, processDecodesMethods inherited from class AbstractUIFormBase
processUpdates, processValidators, setSubmittedMethods inherited from class jakarta.faces.component.UIForm
createUniqueId, getContainerClientId, invokeOnComponent, isPrependId, isSubmitted, setPrependId, visitTreeMethods 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, setTransientMethods 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, unsubscribeFromEventMethods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface jakarta.faces.component.behavior.ClientBehaviorHolder
addClientBehavior, getClientBehaviorsMethods inherited from interface Visual
getRendererType, isPlain
-
Field Details
-
COMPONENT_TYPE
-
COMPONENT_FAMILY
- See Also:
-
-
Constructor Details
-
UIPage
public UIPage()
-
-
Method Details
-
getEventNames
- Specified by:
getEventNamesin interfacejakarta.faces.component.behavior.ClientBehaviorHolder- Overrides:
getEventNamesin classjakarta.faces.component.UIComponentBase
-
getDefaultEventName
- Specified by:
getDefaultEventNamein interfacejakarta.faces.component.behavior.ClientBehaviorHolder- Overrides:
getDefaultEventNamein classjakarta.faces.component.UIComponentBase
-
getFamily
- Overrides:
getFamilyin 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:
getLabelin classAbstractUIPage
-
setLabel
-
getStyleClass
Set a CSS class on the component. This attribute is equivalent to<tc:style customClass="..."/>
. -
setStyleClass
-
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:
getFocusIdin classAbstractUIPage
-
setFocusId
-
isIncludeViewParams
public boolean isIncludeViewParams()- Specified by:
isIncludeViewParamsin classAbstractUIPage
-
setIncludeViewParams
public void setIncludeViewParams(boolean includeViewParams) -
restoreState
- Specified by:
restoreStatein interfacejakarta.faces.component.StateHolder- Overrides:
restoreStatein classjakarta.faces.component.UIComponentBase
-