public interface Form extends Component, Component.BelongToFrame, Component.HasCaption, Component.HasIcon, ComponentContainer, Component.Editable, EditableChangeNotifier, HasContextHelp, ChildEditableController, HasValueSourceProvider, HasHtmlCaption, HasHtmlDescription, HasHtmlSanitizer
Modifier and Type | Interface and Description |
---|---|
static class |
Form.CaptionAlignment
Caption alignment of form child components.
|
static class |
Form.CaptionPosition
Caption position of form child components.
|
EditableChangeNotifier.EditableChangeEvent
HasContextHelp.ContextHelpIconClickEvent
Component.Alignment, Component.BelongToFrame, Component.Disposable, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.OptionsStyleProvider, Component.Wrapper
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
NAME |
AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE, UNITS_PERCENTAGE, UNITS_PIXELS
Modifier and Type | Method and Description |
---|---|
default void |
add(Component... childComponents)
Sequentially adds components to the first column.
|
void |
add(Component childComponent)
Adds a component to the first column.
|
void |
add(Component childComponent,
int column)
Adds a component to the column with the given index.
|
void |
add(Component childComponent,
int column,
int row)
Adds a component to a column with the given index to the given position.
|
void |
add(Component childComponent,
int column,
int colSpan,
int rowSpan)
Adds a component to a column with the given index with the given span.
|
void |
add(Component childComponent,
int column,
int row,
int colSpan,
int rowSpan)
Adds a component to a column with the given index to the given position with the given span.
|
Form.CaptionPosition |
getCaptionPosition() |
Form.CaptionAlignment |
getChildrenCaptionAlignment() |
Form.CaptionAlignment |
getChildrenCaptionAlignment(int column)
Returns alignment of child component captions for a column with the given index.
|
int |
getChildrenCaptionWidth() |
int |
getChildrenCaptionWidth(int column)
Returns fixed caption width for column with a given index.
|
float |
getColumnFlex(int column)
Returns the flex layout ratio for column with a given index.
|
int |
getColumns() |
Component |
getComponent(int column,
int row) |
java.util.Collection<Component> |
getComponents(int column) |
void |
setCaptionPosition(Form.CaptionPosition captionAlignment)
Sets position of component captions.
|
void |
setChildrenCaptionAlignment(Form.CaptionAlignment alignment)
Sets alignment of child component captions in all columns.
|
void |
setChildrenCaptionAlignment(int column,
Form.CaptionAlignment alignment)
Sets alignment of child component captions for a column with the given index.
|
void |
setChildrenCaptionWidth(int width)
Sets fixed captions width for all columns.
|
void |
setChildrenCaptionWidth(int column,
int width)
Set fixed captions width for column with a given index.
|
void |
setColumnFlex(int column,
float flex)
Sets flex layout ratio for column with a given index.
|
void |
setColumns(int columns)
Sets the number of columns in the Form.
|
getFrame, setFrame
getIcon, setIcon, setIconFromSet
focusFirstComponent, getComponent, getComponentNN, getComponents, getOwnComponent, getOwnComponents, getOwnComponentsStream, remove, remove, removeAll
addEditableChangeListener, removeEditableChangeListener
getContextHelpIconClickHandler, getContextHelpText, isContextHelpTextHtmlEnabled, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled
isEditable, isEditableWithParent, setEditable
addStyleName, getAlignment, getHeight, getHeightSizeUnit, getHeightUnits, getId, getParent, getStyleName, getWidth, getWidthSizeUnit, getWidthUnits, isEnabled, isEnabledItself, isEnabledRecursive, isResponsive, isVisible, isVisibleItself, isVisibleRecursive, removeStyleName, requestFocus, setAlignment, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, setStyleName, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedComposition
getValueSourceProvider, setValueSourceProvider
isCaptionAsHtml, setCaptionAsHtml
getCaption, setCaption
getDescription, setDescription
isDescriptionAsHtml, setDescriptionAsHtml
isHtmlSanitizerEnabled, setHtmlSanitizerEnabled
static final java.lang.String NAME
void add(Component childComponent)
add
in interface ComponentContainer
childComponent
- a component to adddefault void add(Component... childComponents)
add
in interface ComponentContainer
childComponents
- components to addvoid add(Component childComponent, int column)
childComponent
- a component to addcolumn
- a columns indexvoid add(Component childComponent, int column, int colSpan, int rowSpan)
childComponent
- a component to addcolumn
- a columns indexcolSpan
- a number of columns a component should spanrowSpan
- a number of rows a component should spanvoid add(Component childComponent, int column, int row)
childComponent
- a component to addcolumn
- a columns indexrow
- a row indexvoid add(Component childComponent, int column, int row, int colSpan, int rowSpan)
childComponent
- a component to addcolumn
- a columns indexrow
- a row indexcolSpan
- a number of columns a component should spanrowSpan
- a number of rows a component should spanjava.util.Collection<Component> getComponents(int column)
column
- a column indexComponent getComponent(int column, int row)
column
- a columns indexrow
- a row indexForm.CaptionPosition getCaptionPosition()
void setCaptionPosition(Form.CaptionPosition captionAlignment)
captionAlignment
- component captions positionint getChildrenCaptionWidth()
void setChildrenCaptionWidth(int width)
width
- fixed caption widthint getChildrenCaptionWidth(int column)
column
- a column indexvoid setChildrenCaptionWidth(int column, int width)
column
- a column indexwidth
- fixed caption width for column with a given indexForm.CaptionAlignment getChildrenCaptionAlignment()
void setChildrenCaptionAlignment(Form.CaptionAlignment alignment)
Applicable only when captions position is Form.CaptionPosition.LEFT
.
alignment
- captions alignmentForm.CaptionAlignment getChildrenCaptionAlignment(int column)
column
- a column index to get captionvoid setChildrenCaptionAlignment(int column, Form.CaptionAlignment alignment)
column
- a column index to set captionalignment
- alignment of child component captions for a column with the given indexint getColumns()
void setColumns(int columns)
columns
- the new number of columns in the Formfloat getColumnFlex(int column)
column
- a column indexvoid setColumnFlex(int column, float flex)
column
- a column indexflex
- the flex ration for the column