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

Class UIAbstractRegion

java.lang.Object

jakarta.faces.component.UIComponent

jakarta.faces.component.UIComponentBase

jakarta.faces.component.UIPanel

com.jk.web.faces.components.layouts.UIAbstractRegion

All Implemented Interfaces:

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:

UIActions, UICenter, UIEnd, UIFields, UINorth, UISouth, UIStart

public class UIAbstractRegion
extends jakarta.faces.component.UIPanel

This class is used for custom Jakarata Server Faces (JSF) components representing regions with optional styling.

This class extends UIPanel and provides common functionality for rendering regions with various styling options.

Version:

1.0

Author:

Dr. Jalal H. Kiswani

Field Summary

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

Constructor Summary

Constructors

Constructor	Description
UIAbstractRegion()

Method Summary

Modifier and Type	Method	Description
void	encodeAll(jakarta.faces.context.FacesContext context)
String	getHeight()	This method retrieves the height of the region.
String	getWidth()	This method retrieves the width of the region.
UIComponentWrapper	getWrapper()	This method retrieves the wrapper for the UIComponent to facilitate attribute handling.
boolean	isFullSpan()	This method checks whether the region should span the full width of the container.
boolean	isRespectHight()	This method checks whether to respect the specified height.
boolean	isRespectWidth()	This method checks whether to respect the specified width.
boolean	isStretchHeight()	This method checks whether to stretch the height to fill the container.
boolean	isStretchWidth()	This method checks whether to stretch the width to fill the container.
void	setFullSpan(boolean fullSpan)	This method sets whether the the region should span the full width of the container to the provided value.
void	setHeight(String height)	This method sets the height of the region to the provided value.
void	setRespectHight(boolean respectHight)	This method sets whether to respect the specified height to the provided value.
void	setRespectWidth(boolean respectWidth)	This method sets whether to respect the specified width or not to the provided value.
void	setStretchHeight(boolean stretchHeight)	This method sets whether to stretch the height to fill the container to the provided value.
void	setStretchWidth(boolean stretchWith)	This method sets whether to stretch the width to fill the container to the provided value.
void	setWidth(String width)	This method sets the width of the region to the provided value.
void	setWrapper(UIComponentWrapper wrapper)	This method sets the wrapper for the UIComponent to facilitate attribute handling 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, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, 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

getClientId, getCompositeComponentParent, getContainerClientId, 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

Constructor Details

UIAbstractRegion

public UIAbstractRegion()

Method Details

encodeAll

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

Overrides:

encodeAll in class jakarta.faces.component.UIComponent

Throws:

IOException

getHeight

public String getHeight()

This method retrieves the height of the region.

Returns:

the height of the region.

getWidth

public String getWidth()

This method retrieves the width of the region.

Returns:

the width of the region.

getWrapper

public UIComponentWrapper getWrapper()

This method retrieves the wrapper for the UIComponent to facilitate attribute handling.

Returns:

the wrapper for the UIComponent to facilitate attribute handling.

isFullSpan

public boolean isFullSpan()

This method checks whether the region should span the full width of the container.

Returns:

true, if the region should span the full width of the container, false otherwise.

isRespectHight

public boolean isRespectHight()

This method checks whether to respect the specified height.

Returns:

true, if the height should be respected, false otherwise.

isRespectWidth

public boolean isRespectWidth()

This method checks whether to respect the specified width.

Returns:

true, if the width should be respected, false otherwise.

isStretchHeight

public boolean isStretchHeight()

This method checks whether to stretch the height to fill the container.

Returns:

true, if the height should be stretched, false otherwise.

isStretchWidth

public boolean isStretchWidth()

This method checks whether to stretch the width to fill the container.

Returns:

true, if the width should be stretched, false otherwise.

setFullSpan

public void setFullSpan(boolean fullSpan)

This method sets whether the the region should span the full width of the container to the provided value.

Parameters:

fullSpan - Indicates the region should span the full width of the container (true) or not (false).

setHeight

public void setHeight(String height)

This method sets the height of the region to the provided value.

Parameters:

height - Specifies the new height of the region.

setRespectHight

public void setRespectHight(boolean respectHight)

This method sets whether to respect the specified height to the provided value.

Parameters:

respectHight - Indicates whether to respect the specified height (true) or not (false).

setRespectWidth

public void setRespectWidth(boolean respectWidth)

This method sets whether to respect the specified width or not to the provided value.

Parameters:

respectWidth - Indicates whether to respect the specified width (true) or not (false).

setStretchHeight

public void setStretchHeight(boolean stretchHeight)

This method sets whether to stretch the height to fill the container to the provided value.

Parameters:

stretchHeight - Indicates whether to stretch the height to fill the container (true) or not (false).

setStretchWidth

public void setStretchWidth(boolean stretchWith)

This method sets whether to stretch the width to fill the container to the provided value.

Parameters:

stretchWith - Indicates whether to stretch the width to fill the container (true) or not (false).

setWidth

public void setWidth(String width)

This method sets the width of the region to the provided value.

Parameters:

width - Specifies the new width of the region.

setWrapper

public void setWrapper(UIComponentWrapper wrapper)

This method sets the wrapper for the UIComponent to facilitate attribute handling to the provided value.

Parameters:

wrapper - Specifies the new wrapper for the UIComponent to facilitate attribute handling.