Package com.storedobject.ui

Class FormSection

java.lang.Object

com.vaadin.flow.component.Component

com.vaadin.flow.component.HtmlComponent

com.vaadin.flow.component.HtmlContainer

com.vaadin.flow.component.html.Div

com.storedobject.ui.Card.Cell

com.storedobject.ui.Card.Row

com.storedobject.ui.FormSection

All Implemented Interfaces:

com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.ClickNotifier<com.vaadin.flow.component.html.Div>, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.HasComponents, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasEnabled, com.vaadin.flow.component.HasOrderedComponents, com.vaadin.flow.component.HasSize, com.vaadin.flow.component.HasStyle, com.vaadin.flow.component.HasText, Serializable

public class FormSection
extends Card.Row

Represents a section of a form, designed as a horizontal row layout for arranging components. A FormSection typically includes a name component and a styled line, which can also be customized in terms of span and height.

Author:

Syam

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FormSection.End	The End class is a specialized subclass of Card.Line, intended to represent a terminating component or marker within a layout structure.

Nested classes/interfaces inherited from interface com.vaadin.flow.component.HasText

com.vaadin.flow.component.HasText.WhiteSpace

Constructor Summary

Constructors

Constructor	Description
FormSection()	Constructs a FormSection with a default column span of 2.
FormSection(int span)	Constructs a FormSection with the specified number of column spans and an empty name.
FormSection(com.vaadin.flow.component.Component name)	Constructs a FormSection with the specified component as its name.
FormSection(com.vaadin.flow.component.Component name, int span)	Constructs a FormSection with a specified name component and column span.
FormSection(String name)	Constructs a new FormSection with the specified name.
FormSection(String name, int span)	Constructs a new FormSection with the specified name and span.

Method Summary

Modifier and Type	Method	Description
Card.Line	getLine()	Retrieves the line associated with the card.
com.vaadin.flow.component.Component	getName()	Retrieves the name component associated with this instance.
void	setColumnSpan(int span)	Sets the column span attribute for the current element.
void	setName(com.vaadin.flow.component.Component name)	Sets the name component for this object and updates its layout.
void	setName(String name)	Updates the name property with the provided value.

Methods inherited from class com.storedobject.ui.Card.Cell

alignBottom, alignCenter, alignTop, justifyCenter, justifyLeft, justifyRight, setGap

Methods inherited from class com.vaadin.flow.component.HtmlComponent

getTitle, setTitle

Methods inherited from class com.vaadin.flow.component.Component

addListener, findAncestor, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getListeners, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onAttach, onDetach, onEnabledStateChanged, removeFromParent, scrollIntoView, scrollIntoView, set, setElement, setId, setVisible

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vaadin.flow.component.AttachNotifier

addAttachListener

Methods inherited from interface com.vaadin.flow.component.ClickNotifier

addClickListener, addClickShortcut, addDoubleClickListener, addSingleClickListener

Methods inherited from interface com.vaadin.flow.component.DetachNotifier

addDetachListener

Methods inherited from interface com.vaadin.flow.component.HasComponents

add, add, add, addComponentAsFirst, addComponentAtIndex, remove, remove, removeAll

Methods inherited from interface com.vaadin.flow.component.HasElement

getElement

Methods inherited from interface com.vaadin.flow.component.HasEnabled

isEnabled, setEnabled

Methods inherited from interface com.vaadin.flow.component.HasOrderedComponents

getChildren, getComponentAt, getComponentCount, indexOf, replace

Methods inherited from interface com.vaadin.flow.component.HasSize

getHeight, getHeightUnit, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getWidth, getWidthUnit, setHeight, setHeight, setHeightFull, setMaxHeight, setMaxHeight, setMaxWidth, setMaxWidth, setMinHeight, setMinHeight, setMinWidth, setMinWidth, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthFull

Methods inherited from interface com.vaadin.flow.component.HasStyle

addClassName, addClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassName

Methods inherited from interface com.vaadin.flow.component.HasText

getText, getWhiteSpace, setText, setWhiteSpace

Constructor Details

FormSection

public FormSection()

Constructs a FormSection with a default column span of 2. Delegates to the constructor that accepts a single integer parameter, defaulting the column span when unspecified.

FormSection

public FormSection(String name)

Constructs a new FormSection with the specified name. This constructor initializes the object with a default column span of 2.

Parameters:

name - the name of the form section

FormSection

public FormSection(com.vaadin.flow.component.Component name)

Constructs a FormSection with the specified component as its name. This constructor initializes the object with a default column span of 2.

Parameters:

name - the component to be used as the name or label for the section

FormSection

public FormSection(int span)

Constructs a FormSection with the specified number of column spans and an empty name.

Parameters:

span - the number of column spans; if less than 1, it defaults to 2

FormSection

public FormSection(String name,
 int span)

Constructs a new FormSection with the specified name and span.

Parameters:

name - the name of the form section

span - the number of columns or space the form section spans

FormSection

public FormSection(com.vaadin.flow.component.Component name,
 int span)

Constructs a FormSection with a specified name component and column span.

Parameters:

name - the component to be used as the name or label for the section.

span - the number of columns the section should span.

Method Details

setColumnSpan

public void setColumnSpan(int span)

Sets the column span attribute for the current element. The column span determines how many columns the element should span across in a grid or table layout. If the provided span is less than 1, a default value of 2 will be used.

Parameters:

span - the desired number of columns the element should span. Must be a positive integer; if less than 1, defaults to 2.

getName

public com.vaadin.flow.component.Component getName()

Retrieves the name component associated with this instance.

Returns:

the name component

setName

public void setName(com.vaadin.flow.component.Component name)

Sets the name component for this object and updates its layout.

Parameters:

name - the Component to be set as the name; can be null

setName

public void setName(String name)

Updates the name property with the provided value. Depending on the type of the current name property, this method will either modify its content or assign a new value.

Parameters:

name - the new name to be set for this instance

getLine

public Card.Line getLine()

Retrieves the line associated with the card.

Returns:

the line of type Card.Line