Class UIFormLayout

java.lang.Object
jakarta.faces.component.UIComponent
jakarta.faces.component.UIComponentBase
jakarta.faces.component.UIPanel
com.jk.web.faces.components.layouts.UILayout
com.jk.web.faces.components.layouts.UIFormLayout
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

public class UIFormLayout extends UILayout
This class is a UI component representing a form layout.

This layout organizes its children components in a table-based format.

Version:
1.0
Author:
Dr. Jalal H. Kiswani
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    Represents the component type for UIFormLayout.

    Fields inherited from class com.jk.web.faces.components.layouts.UILayout

    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
     
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    encodeAll(jakarta.faces.context.FacesContext context)
    int
    This method retrieves the cell width.
    int
    This method gets the number of columns in the layout.
    This method retrieves the layout title.
    void
    setCellWidth(int cellWidth)
    This method sets the cell width to the provided value.
    void
    setCols(int cols)
    This method sets the number of columns in this layout to the provided value.
    void
    This method sets the layout title.

    Methods inherited from class com.jk.web.faces.components.layouts.UILayout

    encodeBegin, encodeChildren, encodeEnd, getContainerClientId, getRendersChildren, getWrapper, isPrependId, setPrependId, setWrapper

    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

    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

    • JK_LAYOUT_FORM_LAYOUT

      public static final String JK_LAYOUT_FORM_LAYOUT
      Represents the component type for UIFormLayout.
      See Also:
  • Constructor Details

    • UIFormLayout

      public UIFormLayout()
  • Method Details

    • encodeAll

      public void encodeAll(jakarta.faces.context.FacesContext context) throws IOException
      Overrides:
      encodeAll in class jakarta.faces.component.UIComponent
      Throws:
      IOException
    • getCellWidth

      public int getCellWidth()
      This method retrieves the cell width.
      Returns:
      the cell width.
    • getCols

      public int getCols()
      This method gets the number of columns in the layout.
      Returns:
      the number of columns in the layout.
    • getTitle

      public String getTitle()
      This method retrieves the layout title.
      Returns:
      the layout title.
    • setCellWidth

      public void setCellWidth(int cellWidth)
      This method sets the cell width to the provided value.
      Parameters:
      cellWidth - Specifies the new cell width.
    • setCols

      public void setCols(int cols)
      This method sets the number of columns in this layout to the provided value.
      Parameters:
      cols - Specifies the new number of columns in this layout.
    • setTitle

      public void setTitle(String title)
      This method sets the layout title.
      Parameters:
      title - Specifies the new layout title.