public class GridLayoutImpl extends AbstractComponent<JmixGridLayout> implements GridLayout
GridLayout.Area
Component.Alignment, Component.BelongToFrame, Component.Disposable, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.Wrapper
HasContextHelp.ContextHelpIconClickEvent
LayoutClickNotifier.LayoutClickEvent
Modifier and Type | Field and Description |
---|---|
protected com.vaadin.shared.Registration |
layoutClickRegistration |
protected java.util.List<Component> |
ownComponents |
protected java.util.Map<ShortcutAction,com.vaadin.event.ShortcutListener> |
shortcuts |
alignment, applicationContext, component, contextHelpIconClickHandler, contextHelpIconClickListener, descriptionAsHtml, element, frame, htmlSanitizerEnabled, icon, ICON_STYLE, id, parent
NAME
AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE
Constructor and Description |
---|
GridLayoutImpl() |
Modifier and Type | Method and Description |
---|---|
void |
add(Component childComponent)
Adds a component to this container.
|
void |
add(Component component,
int col,
int row) |
void |
add(Component childComponent,
int col,
int row,
int col2,
int row2) |
io.jmix.core.common.event.Subscription |
addLayoutClickListener(java.util.function.Consumer<LayoutClickNotifier.LayoutClickEvent> listener)
Adds a listener that is fired when user clicks inside the layout at any place.
|
void |
addShortcutAction(ShortcutAction action) |
void |
attached()
Notifies all listeners that component has been attached.
|
protected JmixGridLayout |
createComponent() |
void |
detached()
Notifies all listeners that component has been detached.
|
protected Component |
findChildComponent(com.vaadin.ui.Component vComponent) |
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)
Gets a component belonging to the whole components tree below this container.
|
GridLayout.Area |
getComponentArea(Component childComponent)
Returns information about the area where given component is laid in the
GridLayout.
|
java.util.Collection<Component> |
getComponents()
Gets all components belonging to the whole components tree below this container.
|
MarginInfo |
getMargin() |
Component |
getOwnComponent(java.lang.String id)
Gets component directly owned by this container.
|
java.util.Collection<Component> |
getOwnComponents()
Gets all components directly owned by this container.
|
java.util.stream.Stream<Component> |
getOwnComponentsStream()
Gets stream of all components directly owned by this container.
|
float |
getRowExpandRatio(int row) |
int |
getRows() |
boolean |
getSpacing() |
protected void |
internalRemoveLayoutClickListener(java.util.function.Consumer<LayoutClickNotifier.LayoutClickEvent> listener) |
boolean |
isRequiredIndicatorVisible()
Returns whether a required indicator should be shown.
|
void |
remove(Component childComponent)
Removes a component from this container.
|
void |
removeAll()
Removes all components from this container.
|
void |
removeShortcutAction(ShortcutAction action) |
void |
setColumnExpandRatio(int col,
float ratio) |
void |
setColumns(int columns) |
void |
setFrame(Frame frame) |
void |
setMargin(MarginInfo marginInfo) |
void |
setRequiredIndicatorVisible(boolean visible)
Sets whether a required indicator should be shown.
|
void |
setRowExpandRatio(int row,
float ratio) |
void |
setRows(int rows) |
void |
setSpacing(boolean enabled) |
addAttachListener, addDetachListener, addStyleName, assignDebugId, getAlignment, getCaption, getComponent, getComposition, getContextHelpIconClickHandler, getContextHelpText, getDebugId, getDescription, getEventHub, getFrame, getHeight, getHeightSizeUnit, getHtmlSanitizer, getIcon, getIconName, getIconResource, getId, getParent, getStyleName, getUiComponentProperties, getUiProperties, getWidth, getWidthSizeUnit, getXmlDescriptor, hasSubscriptions, hasValidationError, isAttached, isCaptionAsHtml, isContextHelpTextHtmlEnabled, isDescriptionAsHtml, isEnabled, isEnabledRecursive, isHtmlSanitizerEnabled, isResponsive, isVisible, isVisibleRecursive, onContextHelpIconClick, publish, removeStyleName, sanitize, setAlignment, setApplicationContext, setCaption, setCaptionAsHtml, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled, setDebugId, setDescription, setDescriptionAsHtml, setEnabled, setHeight, setHtmlSanitizerEnabled, setIcon, setIconFromSet, setId, setParent, setResponsive, setStyleName, setValidationError, setVisible, setWidth, setXmlDescriptor, unsubscribe, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedComposition
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getComponentNN
add, remove
focusFirstComponent, getComponentNN
getFrame
addStyleName, getAlignment, getHeight, getHeightSizeUnit, getId, getParent, getStyleName, getWidth, getWidthSizeUnit, isEnabled, isEnabledRecursive, isResponsive, isVisible, isVisibleRecursive, removeStyleName, setAlignment, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, setStyleName, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedComposition
getIcon, setIcon, setIconFromSet
getContextHelpIconClickHandler, getContextHelpText, isContextHelpTextHtmlEnabled, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled
isCaptionAsHtml, setCaptionAsHtml
getCaption, setCaption
getDescription, setDescription
isDescriptionAsHtml, setDescriptionAsHtml
isHtmlSanitizerEnabled, setHtmlSanitizerEnabled
protected java.util.List<Component> ownComponents
protected com.vaadin.shared.Registration layoutClickRegistration
protected java.util.Map<ShortcutAction,com.vaadin.event.ShortcutListener> shortcuts
protected JmixGridLayout createComponent()
public void add(Component childComponent)
ComponentContainer
add
in interface ComponentContainer
childComponent
- a component to addpublic float getColumnExpandRatio(int col)
getColumnExpandRatio
in interface GridLayout
public void setColumnExpandRatio(int col, float ratio)
setColumnExpandRatio
in interface GridLayout
public float getRowExpandRatio(int row)
getRowExpandRatio
in interface GridLayout
public void setRowExpandRatio(int row, float ratio)
setRowExpandRatio
in interface GridLayout
public void add(Component component, int col, int row)
add
in interface GridLayout
public void add(Component childComponent, int col, int row, int col2, int row2)
add
in interface GridLayout
public int getRows()
getRows
in interface GridLayout
public void setRows(int rows)
setRows
in interface GridLayout
public int getColumns()
getColumns
in interface GridLayout
public void setColumns(int columns)
setColumns
in interface GridLayout
@Nullable public Component getComponent(int columnIndex, int rowIndex)
GridLayout
getComponent
in interface GridLayout
columnIndex
- the column index, starting from 0 for the leftmost column.rowIndex
- the row index, starting from 0 for the topmost row.@Nullable public GridLayout.Area getComponentArea(Component childComponent)
GridLayout
getComponentArea
in interface GridLayout
childComponent
- the component whose area information is requested.public void remove(Component childComponent)
ComponentContainer
remove
in interface ComponentContainer
childComponent
- a component to removepublic void removeAll()
ComponentContainer
removeAll
in interface ComponentContainer
public void setFrame(@Nullable Frame frame)
setFrame
in interface Component.BelongToFrame
setFrame
in class AbstractComponent<JmixGridLayout>
@Nullable public Component getOwnComponent(java.lang.String id)
HasComponents
getOwnComponent
in interface HasComponents
@Nullable public Component getComponent(java.lang.String id)
HasComponents
getComponent
in interface HasComponents
public java.util.Collection<Component> getOwnComponents()
HasComponents
getOwnComponents
in interface HasComponents
public java.util.stream.Stream<Component> getOwnComponentsStream()
HasComponents
getOwnComponentsStream
in interface HasComponents
public java.util.Collection<Component> getComponents()
HasComponents
getComponents
in interface HasComponents
public void setMargin(MarginInfo marginInfo)
public MarginInfo getMargin()
public void setSpacing(boolean enabled)
setSpacing
in interface HasSpacing
public boolean getSpacing()
getSpacing
in interface HasSpacing
public io.jmix.core.common.event.Subscription addLayoutClickListener(java.util.function.Consumer<LayoutClickNotifier.LayoutClickEvent> listener)
LayoutClickNotifier
addLayoutClickListener
in interface LayoutClickNotifier
listener
- a listener to add@Nullable protected Component findChildComponent(com.vaadin.ui.Component vComponent)
protected void internalRemoveLayoutClickListener(java.util.function.Consumer<LayoutClickNotifier.LayoutClickEvent> listener)
public void addShortcutAction(ShortcutAction action)
addShortcutAction
in interface ShortcutNotifier
public void removeShortcutAction(ShortcutAction action)
removeShortcutAction
in interface ShortcutNotifier
public boolean isRequiredIndicatorVisible()
HasRequiredIndicator
isRequiredIndicatorVisible
in interface HasRequiredIndicator
true
if a required indicator should be shown, false
otherwisepublic void setRequiredIndicatorVisible(boolean visible)
HasRequiredIndicator
setRequiredIndicatorVisible
in interface HasRequiredIndicator
visible
- true
if a required indicator should be shown, false
otherwisepublic void attached()
AttachNotifier
attached
in interface AttachNotifier
attached
in class AbstractComponent<JmixGridLayout>
public void detached()
AttachNotifier
detached
in interface AttachNotifier
detached
in class AbstractComponent<JmixGridLayout>