com.haulmont.cuba.desktop.gui.components

Class DesktopGridLayout

java.lang.Object

com.haulmont.cuba.desktop.gui.components.DesktopAbstractComponent<javax.swing.JPanel>

com.haulmont.cuba.desktop.gui.components.DesktopGridLayout

All Implemented Interfaces:

DesktopComponent, DesktopContainer, Component, Component.BelongToFrame, Component.Container, Component.HasCaption, Component.HasIcon, Component.HasXmlDescriptor, Component.LayoutClickNotifier, Component.Margin, Component.ShortcutNotifier, Component.Spacing, Component.Wrapper, GridLayout

public class DesktopGridLayout
extends DesktopAbstractComponent<javax.swing.JPanel>
implements GridLayout, DesktopContainer

Nested Class Summary

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

GridLayout.Area

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

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

DesktopComponent.HasContextHelpClickHandler

Field Summary

Fields inherited from class com.haulmont.cuba.desktop.gui.components.DesktopAbstractComponent

SWING_PROPERTY_CLASS, SWING_PROPERTY_ID

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

NAME

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

AUTO_SIZE, AUTO_SIZE_PX, UNITS_PERCENTAGE, UNITS_PIXELS

Constructor Summary

Constructors

Constructor and Description
DesktopGridLayout()

Method Summary

Modifier and Type	Method and Description
void	add(Component component)
void	add(Component component, int col, int row)
void	add(Component component, int col, int row, int col2, int row2)
void	addLayoutClickListener(Component.LayoutClickListener listener)
void	addShortcutAction(Component.ShortcutAction action)
float	getColumnExpandRatio(int col)
int	getColumns()
Component	getComponent(int columnIndex, int rowIndex) Gets the Component at given row and column.
Component	getComponent(java.lang.String id) Get component belonging to the whole components tree below this container.
GridLayout.Area	getComponentArea(Component component) Returns information about the area where given component is laid in the GridLayout.
java.util.Collection<Component>	getComponents() Get all components belonging to the whole components tree below this container
java.lang.String	getDescription()
MarginInfo	getMargin()
Component	getOwnComponent(java.lang.String id) Get component directly owned by this container.
java.util.Collection<Component>	getOwnComponents() Get all components directly owned by this container
float	getRowExpandRatio(int row)
int	getRows()
boolean	getSpacing()
void	remove(Component component)
void	removeAll()
void	removeLayoutClickListener(Component.LayoutClickListener listener)
void	removeShortcutAction(Component.ShortcutAction action)
void	setColumnExpandRatio(int col, float ratio)
void	setColumns(int columns)
void	setDescription(java.lang.String description)
void	setFrame(Frame frame)
void	setMargin(MarginInfo marginInfo)
void	setRowExpandRatio(int row, float ratio)
void	setRows(int rows)
void	setSpacing(boolean enabled)
void	updateComponent(Component child)
void	updateEnabled()

Methods inherited from class com.haulmont.cuba.desktop.gui.components.DesktopAbstractComponent

addStyleName, assignAutoDebugId, getAlignment, getCaption, getComponent, getComposition, getDebugId, getFrame, getHeight, getHeightUnits, getIcon, getId, getParent, getStyleName, getTabIndex, getWidth, getWidthUnits, getXmlDescriptor, isComponentVisible, isEnabled, isEnabledItself, isParentEnabled, isResponsive, isVisible, isVisibleItself, removeStyleName, requestFocus, setAlignment, setCaption, setContainer, setDebugId, setEnabled, setExpanded, setHeight, setIcon, setIconFromSet, setId, setParent, setParentEnabled, setResponsive, setStyleName, setTabIndex, setVisible, setWidth, setXmlDescriptor, unwrap, unwrapComposition

Methods inherited from class java.lang.Object

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

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

getComponentNN

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

setMargin, setMargin

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

getFrame

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, setCaption

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

getComponentNN

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

Constructor Detail

DesktopGridLayout

public DesktopGridLayout()

Method Detail

getColumnExpandRatio

public float getColumnExpandRatio(int col)

Specified by:

getColumnExpandRatio in interface GridLayout

setColumnExpandRatio

public void setColumnExpandRatio(int col,
                                 float ratio)

Specified by:

setColumnExpandRatio in interface GridLayout

getRowExpandRatio

public float getRowExpandRatio(int row)

Specified by:

getRowExpandRatio in interface GridLayout

setRowExpandRatio

public void setRowExpandRatio(int row,
                              float ratio)

Specified by:

setRowExpandRatio in interface GridLayout

add

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

Specified by:

add in interface GridLayout

add

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

Specified by:

add in interface GridLayout

setFrame

public void setFrame(Frame frame)

Specified by:

setFrame in interface Component.BelongToFrame

Overrides:

setFrame in class DesktopAbstractComponent<javax.swing.JPanel>

getRows

public int getRows()

Specified by:

getRows in interface GridLayout

setRows

public void setRows(int rows)

Specified by:

setRows in interface GridLayout

getColumns

public int getColumns()

Specified by:

getColumns in interface GridLayout

setColumns

public void setColumns(int columns)

Specified by:

setColumns in interface GridLayout

getComponent

@Nullable
public Component getComponent(int columnIndex,
                                        int rowIndex)

Description copied from interface: GridLayout

Gets the Component at given row and column.

Specified by:

getComponent in interface GridLayout

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

getComponentArea

@Nullable
public GridLayout.Area getComponentArea(Component component)

Description copied from interface: GridLayout

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

Specified by:

getComponentArea in interface GridLayout

Parameters:

component - the component whose area information is requested.

Returns:

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

add

public void add(Component component)

Specified by:

add in interface Component.Container

remove

public void remove(Component component)

Specified by:

remove in interface Component.Container

removeAll

public void removeAll()

Specified by:

removeAll in interface Component.Container

getOwnComponent

public Component getOwnComponent(java.lang.String id)

Description copied from interface: Component.Container

Get component directly owned by this container.

Specified by:

getOwnComponent in interface Component.Container

Returns:

component or null if not found

getComponent

@Nullable
public Component getComponent(java.lang.String id)

Description copied from interface: Component.Container

Get component belonging to the whole components tree below this container.

Specified by:

getComponent in interface Component.Container

Returns:

component or null if not found

getOwnComponents

public java.util.Collection<Component> getOwnComponents()

Description copied from interface: Component.Container

Get all components directly owned by this container

Specified by:

getOwnComponents in interface Component.Container

getComponents

public java.util.Collection<Component> getComponents()

Description copied from interface: Component.Container

Get all components belonging to the whole components tree below this container

Specified by:

getComponents in interface Component.Container

setMargin

public void setMargin(MarginInfo marginInfo)

Specified by:

setMargin in interface Component.Margin

getMargin

public MarginInfo getMargin()

Specified by:

getMargin in interface Component.Margin

setSpacing

public void setSpacing(boolean enabled)

Specified by:

setSpacing in interface Component.Spacing

getSpacing

public boolean getSpacing()

Specified by:

getSpacing in interface Component.Spacing

updateComponent

public void updateComponent(Component child)

Specified by:

updateComponent in interface DesktopContainer

updateEnabled

public void updateEnabled()

getDescription

public java.lang.String getDescription()

Specified by:

getDescription in interface Component.HasCaption

setDescription

public void setDescription(java.lang.String description)

Specified by:

setDescription in interface Component.HasCaption

addLayoutClickListener

public void addLayoutClickListener(Component.LayoutClickListener listener)

Specified by:

addLayoutClickListener in interface Component.LayoutClickNotifier

removeLayoutClickListener

public void removeLayoutClickListener(Component.LayoutClickListener listener)

Specified by:

removeLayoutClickListener in interface Component.LayoutClickNotifier

addShortcutAction

public void addShortcutAction(Component.ShortcutAction action)

Specified by:

addShortcutAction in interface Component.ShortcutNotifier

removeShortcutAction

public void removeShortcutAction(Component.ShortcutAction action)

Specified by:

removeShortcutAction in interface Component.ShortcutNotifier