Package com.jk.web.faces.components.layouts

Class UILayout

java.lang.Object

jakarta.faces.component.UIComponent

jakarta.faces.component.UIComponentBase

jakarta.faces.component.UIPanel

com.jk.web.faces.components.layouts.UILayout

All Implemented Interfaces:

jakarta.faces.component.NamingContainer, jakarta.faces.component.PartialStateHolder, jakarta.faces.component.StateHolder, jakarta.faces.component.TransientStateHolder, jakarta.faces.event.ComponentSystemEventListener, jakarta.faces.event.FacesListener, jakarta.faces.event.SystemEventListenerHolder, EventListener

Direct Known Subclasses:

UIBorderLayout, UIFormLayout, UIGridLayout

public class UILayout
extends jakarta.faces.component.UIPanel
implements jakarta.faces.component.NamingContainer

This class is a UI components that represent layouts.

It extends UIPanel and implements NamingContainer.

Version:

1.0

Author:

Dr. Jalal H. Kiswani

Field Summary

Fields

Modifier and Type	Field	Description
protected Logger	logger	Represents this class logger.

Fields inherited from class jakarta.faces.component.UIPanel

COMPONENT_FAMILY, COMPONENT_TYPE

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

Constructor	Description
UILayout()

Method Summary

Modifier and Type	Method	Description
void	encodeBegin(jakarta.faces.context.FacesContext context)
void	encodeChildren(jakarta.faces.context.FacesContext context)
void	encodeEnd(jakarta.faces.context.FacesContext context)
String	getContainerClientId(jakarta.faces.context.FacesContext context)
boolean	getRendersChildren()
UIComponentWrapper	getWrapper()	This method retrieves the UIComponentWrapper associated with this layout.
boolean	isPrependId()	This method checks whether the prependId property is set to true or false.
void	setPrependId(boolean prependId)	This method sets the prependId property to control whether the ID should include its own ID or not.
void	setWrapper(UIComponentWrapper wrapper)	This method sets the UIComponentWrapper for this layout to the provided value.

Methods inherited from class jakarta.faces.component.UIPanel

getFamily

Methods inherited from class jakarta.faces.component.UIComponentBase

addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class jakarta.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, visitTree

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

logger

protected Logger logger

Represents this class logger.

Constructor Details

UILayout

public UILayout()

Method Details

encodeBegin

public void encodeBegin(jakarta.faces.context.FacesContext context)
                 throws IOException

Overrides:

encodeBegin in class jakarta.faces.component.UIComponentBase

Throws:

IOException

encodeChildren

public void encodeChildren(jakarta.faces.context.FacesContext context)
                    throws IOException

Overrides:

encodeChildren in class jakarta.faces.component.UIComponentBase

Throws:

IOException

encodeEnd

public void encodeEnd(jakarta.faces.context.FacesContext context)
               throws IOException

Overrides:

encodeEnd in class jakarta.faces.component.UIComponentBase

Throws:

IOException

getContainerClientId

public String getContainerClientId(jakarta.faces.context.FacesContext context)

Overrides:

getContainerClientId in class jakarta.faces.component.UIComponent

getRendersChildren

public boolean getRendersChildren()

Overrides:

getRendersChildren in class jakarta.faces.component.UIComponentBase

getWrapper

public UIComponentWrapper getWrapper()

This method retrieves the UIComponentWrapper associated with this layout.

Returns:

the UIComponentWrapper associated with this layout.

isPrependId

public boolean isPrependId()

This method checks whether the prependId property is set to true or false.

Returns:

true, if it is true, false otherwise.

setPrependId

public void setPrependId(boolean prependId)

This method sets the prependId property to control whether the ID should include its own ID or not.

Parameters:

prependId - Indicates whether to include ID (true) or not (false).

setWrapper

public void setWrapper(UIComponentWrapper wrapper)

This method sets the UIComponentWrapper for this layout to the provided value.

Parameters:

wrapper - Specifies the new UIComponentWrapper for this layout.