com.haulmont.cuba.gui.components

Interface GridLayout

All Superinterfaces:

Component, Component.BelongToFrame, Component.Container, Component.HasCaption, Component.HasIcon, Component.LayoutClickNotifier, Component.Margin, Component.ShortcutNotifier, Component.Spacing

public interface GridLayout
extends Component.Container, Component.Spacing, Component.Margin, Component.BelongToFrame, Component.HasIcon, Component.HasCaption, Component.LayoutClickNotifier, Component.ShortcutNotifier

A layout where the components are laid out on a grid using cell coordinates.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	GridLayout.Area Defines a rectangular area of cells in a GridLayout.

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.Component

Component.ActionOwner, Component.ActionsHolder, Component.Alignment, Component.BelongToFrame, Component.Buffered, Component.ChildEditableController, Component.Collapsable, Component.Container, Component.ContextHelpIconClickEvent, Component.Disposable, Component.Editable, Component.EditableChangeEvent, Component.EditableChangeListener, Component.EditableChangeNotifier, Component.ExpandedStateChangeEvent, Component.ExpandedStateChangeListener, Component.Focusable, Component.HasBorder, Component.HasButtonsPanel, Component.HasCaption, Component.HasContextHelp, Component.HasFormatter, Component.HasIcon, Component.HasInputPrompt, Component.HasNamedComponents, Component.HasOptionsStyleProvider, Component.HasPresentations, Component.HasRowsCount, Component.HasSettings, Component.HasValue, Component.HasXmlDescriptor, Component.LayoutClickEvent, Component.LayoutClickListener, Component.LayoutClickNotifier, Component.Margin, Component.MouseEventDetails, Component.OptionsStyleProvider, Component.OrderedContainer, Component.OuterMargin, Component.SecuredActionsHolder, Component.ShortcutAction, Component.ShortcutNotifier, Component.ShortcutTriggeredEvent, Component.Spacing, Component.UiPermissionAware, Component.Validatable, Component.ValueChangeEvent, Component.ValueChangeListener, Component.Wrapper

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

Fields inherited from interface com.haulmont.cuba.gui.components.Component

AUTO_SIZE, AUTO_SIZE_PX, UNITS_PERCENTAGE, UNITS_PIXELS

Method Summary

Modifier and Type	Method and Description
void	add(Component component, int col, int row)
void	add(Component component, int col, int row, int col2, int row2)
float	getColumnExpandRatio(int col)
int	getColumns()
Component	getComponent(int columnIndex, int rowIndex) Gets the Component at given row and column.
GridLayout.Area	getComponentArea(Component component) Returns information about the area where given component is laid in the GridLayout.
default Component	getComponentNN(int columnIndex, int rowIndex) Gets the Component at given row and column.
float	getRowExpandRatio(int row)
int	getRows()
void	setColumnExpandRatio(int col, float ratio)
void	setColumns(int columns)
void	setRowExpandRatio(int row, float ratio)
void	setRows(int rows)

Methods inherited from interface com.haulmont.cuba.gui.components.Component.Container

add, getComponent, getComponentNN, getComponents, getOwnComponent, getOwnComponents, remove, removeAll

Methods inherited from interface com.haulmont.cuba.gui.components.Component.Spacing

getSpacing, setSpacing

Methods inherited from interface com.haulmont.cuba.gui.components.Component.Margin

getMargin, setMargin, setMargin, setMargin

Methods inherited from interface com.haulmont.cuba.gui.components.Component.BelongToFrame

getFrame, setFrame

Methods inherited from interface com.haulmont.cuba.gui.components.Component

addStyleName, getAlignment, getDebugId, getHeight, getHeightUnits, getId, getParent, getStyleName, getWidth, getWidthUnits, isEnabled, isEnabledItself, isResponsive, isVisible, isVisibleItself, removeStyleName, requestFocus, setAlignment, setDebugId, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, setStyleName, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasIcon

getIcon, setIcon, setIconFromSet

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasCaption

getCaption, getDescription, setCaption, setDescription

Methods inherited from interface com.haulmont.cuba.gui.components.Component.LayoutClickNotifier

addLayoutClickListener, removeLayoutClickListener

Methods inherited from interface com.haulmont.cuba.gui.components.Component.ShortcutNotifier

addShortcutAction, removeShortcutAction

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

getColumnExpandRatio

float getColumnExpandRatio(int col)

setColumnExpandRatio

void setColumnExpandRatio(int col,
                          float ratio)

getRowExpandRatio

float getRowExpandRatio(int row)

setRowExpandRatio

void setRowExpandRatio(int row,
                       float ratio)

add

void add(Component component,
         int col,
         int row)

add

void add(Component component,
         int col,
         int row,
         int col2,
         int row2)

getRows

int getRows()

setRows

void setRows(int rows)

getColumns

int getColumns()

setColumns

void setColumns(int columns)

getComponent

@Nullable
Component getComponent(int columnIndex,
                                 int rowIndex)

Gets the Component at given row and column.

Parameters:

columnIndex - the column index, starting from 0 for the leftmost column.

rowIndex - the row index, starting from 0 for the topmost row.

Returns:

Component in given cell or null if empty

getComponentNN

@Nonnull
default Component getComponentNN(int columnIndex,
                                          int rowIndex)

Gets the Component at given row and column.

Parameters:

columnIndex - the column index, starting from 0 for the leftmost column.

rowIndex - the row index, starting from 0 for the topmost row.

Returns:

component. Throws exception if not found.

getComponentArea

@Nullable
GridLayout.Area getComponentArea(Component component)

Returns information about the area where given component is laid in the GridLayout.

Parameters:

component - the component whose area information is requested.

Returns:

an Area object that contains information how component is laid in the grid