com.haulmont.cuba.desktop.gui.components

Class DesktopScrollBoxLayout

java.lang.Object

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

com.haulmont.cuba.desktop.gui.components.DesktopScrollBoxLayout

All Implemented Interfaces:

AutoExpanding, DesktopComponent, DesktopContainer, Component, Component.BelongToFrame, Component.Container, Component.HasCaption, Component.HasIcon, Component.HasXmlDescriptor, Component.Margin, Component.OrderedContainer, Component.ShortcutNotifier, Component.Spacing, Component.Wrapper, ScrollBoxLayout

public class DesktopScrollBoxLayout
extends DesktopAbstractComponent<javax.swing.JScrollPane>
implements ScrollBoxLayout, AutoExpanding, DesktopContainer

Nested Class Summary

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

ScrollBoxLayout.Orientation, ScrollBoxLayout.ScrollBarPolicy

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.Disposable, Component.Editable, Component.EditableChangeEvent, Component.EditableChangeListener, Component.EditableChangeNotifier, Component.ExpandedStateChangeEvent, Component.ExpandedStateChangeListener, Component.Focusable, Component.HasBorder, Component.HasButtonsPanel, Component.HasCaption, Component.HasFormatter, Component.HasIcon, Component.HasInputPrompt, Component.HasNamedComponents, Component.HasPresentations, Component.HasRowsCount, Component.HasSettings, Component.HasValue, Component.HasXmlDescriptor, Component.LayoutClickEvent, Component.LayoutClickListener, Component.LayoutClickNotifier, Component.Margin, Component.MouseEventDetails, 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 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.ScrollBoxLayout

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
DesktopScrollBoxLayout()

Method Summary

Modifier and Type	Method and Description
void	add(Component component)
void	add(Component component, int index)
void	addShortcutAction(Component.ShortcutAction action)
boolean	expandsHeight()
boolean	expandsWidth()
java.lang.String	getCaption()
Component	getComponent(int index) Returns the component at the given position.
Component	getComponent(java.lang.String id) Get component belonging to the whole components tree below this container.
java.util.Collection<Component>	getComponents() Get all components belonging to the whole components tree below this container
java.lang.String	getDescription()
MarginInfo	getMargin()
ScrollBoxLayout.Orientation	getOrientation()
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
ScrollBoxLayout.ScrollBarPolicy	getScrollBarPolicy()
boolean	getSpacing()
int	indexOf(Component child)
void	remove(Component component)
void	removeAll()
void	removeShortcutAction(Component.ShortcutAction action)
void	setCaption(java.lang.String caption)
void	setDescription(java.lang.String description)
void	setFrame(Frame frame)
void	setMargin(MarginInfo marginInfo)
void	setOrientation(ScrollBoxLayout.Orientation orientation)
void	setScrollBarPolicy(ScrollBoxLayout.ScrollBarPolicy scrollBarPolicy)
void	setSpacing(boolean enabled)
void	updateComponent(Component child)
void	updateEnabled()

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

addStyleName, assignAutoDebugId, getAlignment, getComponent, getComposition, getDebugId, getFrame, getHeight, getHeightUnits, getIcon, getId, getParent, getStyleName, getTabIndex, getWidth, getWidthUnits, getXmlDescriptor, isComponentVisible, isEnabled, isEnabledItself, isParentEnabled, isResponsive, isVisible, isVisibleItself, removeStyleName, requestFocus, setAlignment, setContainer, setDebugId, setEnabled, setExpanded, setHeight, setIcon, 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.Component.OrderedContainer

getComponentNN

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

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

getFrame

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

setMargin, setMargin

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

getIcon, setIcon

Constructor Detail

DesktopScrollBoxLayout

public DesktopScrollBoxLayout()

Method Detail

add

public void add(Component component)

Specified by:

add in interface Component.Container

add

public void add(Component component,
                int index)

Specified by:

add in interface Component.OrderedContainer

indexOf

public int indexOf(Component child)

Specified by:

indexOf in interface Component.OrderedContainer

getComponent

@Nullable
public Component getComponent(int index)

Description copied from interface: Component.OrderedContainer

Returns the component at the given position.

Specified by:

getComponent in interface Component.OrderedContainer

Parameters:

index - component index

Returns:

the component at the given index or null.

remove

public void remove(Component component)

Specified by:

remove in interface Component.Container

removeAll

public void removeAll()

Specified by:

removeAll in interface Component.Container

setFrame

public void setFrame(Frame frame)

Specified by:

setFrame in interface Component.BelongToFrame

Overrides:

setFrame in class DesktopAbstractComponent<javax.swing.JScrollPane>

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

expandsWidth

public boolean expandsWidth()

Specified by:

expandsWidth in interface AutoExpanding

expandsHeight

public boolean expandsHeight()

Specified by:

expandsHeight in interface AutoExpanding

getOrientation

public ScrollBoxLayout.Orientation getOrientation()

Specified by:

getOrientation in interface ScrollBoxLayout

setOrientation

public void setOrientation(ScrollBoxLayout.Orientation orientation)

Specified by:

setOrientation in interface ScrollBoxLayout

getScrollBarPolicy

public ScrollBoxLayout.ScrollBarPolicy getScrollBarPolicy()

Specified by:

getScrollBarPolicy in interface ScrollBoxLayout

setScrollBarPolicy

public void setScrollBarPolicy(ScrollBoxLayout.ScrollBarPolicy scrollBarPolicy)

Specified by:

setScrollBarPolicy in interface ScrollBoxLayout

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()

getCaption

public java.lang.String getCaption()

Specified by:

getCaption in interface Component.HasCaption

Overrides:

getCaption in class DesktopAbstractComponent<javax.swing.JScrollPane>

setCaption

public void setCaption(java.lang.String caption)

Specified by:

setCaption in interface Component.HasCaption

Overrides:

setCaption in class DesktopAbstractComponent<javax.swing.JScrollPane>

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

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