Package com.storedobject.vaadin

Class Box

java.lang.Object

com.vaadin.flow.component.Component

com.vaadin.flow.component.Composite<com.vaadin.flow.component.Component>

com.storedobject.vaadin.Box

All Implemented Interfaces:

com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasStyle, Serializable

@CssImport("./so/hover/styles.css")
public class Box
extends com.vaadin.flow.component.Composite<com.vaadin.flow.component.Component>

Using this class one can draw a "box" around any Vaadin component. If you have a component, in order to enclose it in a box, just use new Box(component). Box is drawn as per "HTML Box Model".

Author:

Syam

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
Box(com.vaadin.flow.component.Component component)	Put a component inside a box.

Method Summary

Modifier and Type	Method	Description
void	alignSizing()	Align the box in such way that total width/height of the box will be same as component's width/height.
com.vaadin.flow.component.Component	getContent()
void	grey()	Create a grey background style.
protected com.vaadin.flow.component.Component	initContent()
void	setBorderColor(String color)	Set border color.
void	setBorderRadius(int radius)	Set border radius.
void	setBorderStyle(String style)	Set border style.
void	setBorderWidth(int widthInPixels)	Set border width.
void	setBorderWidth(String widths)	Set border width.
void	setEnabled(boolean enabled)	Set enabled/disabled style.
void	setHiliteOnHover(boolean hilite)	Hilite the content on hover by making the background to "var(--lumo-primary-color-50pct)".
void	setMargin(int margin)	Set margin.
void	setMargin(String margins)	Set margin.
void	setPadding(int padding)	Set padding.
void	setPadding(String paddings)	Set padding.
void	setReadOnly(boolean readOnly)	Set read only style.
void	setStyle(String style, String value)	Directly set styles.

Methods inherited from class com.vaadin.flow.component.Composite

getChildren, getElement

Methods inherited from class com.vaadin.flow.component.Component

addListener, findAncestor, fireEvent, from, get, getEventBus, getId, getListeners, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onAttach, onDetach, onEnabledStateChanged, removeFromParent, scrollIntoView, scrollIntoView, set, setElement, setId, setVisible

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vaadin.flow.component.AttachNotifier

addAttachListener

Methods inherited from interface com.vaadin.flow.component.DetachNotifier

addDetachListener

Methods inherited from interface com.vaadin.flow.component.HasStyle

addClassName, addClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassName

Constructor Details

Box

public Box(com.vaadin.flow.component.Component component)

Put a component inside a box. Default behaviour of the box:

Border style: solid, Border width: 2, Border colour: var(--lumo-contrast-20pct), Padding: 4, Border radius: 5

Parameters:

component - Component to be boxed.

Method Details

initContent

protected com.vaadin.flow.component.Component initContent()

Overrides:

initContent in class com.vaadin.flow.component.Composite<com.vaadin.flow.component.Component>

getContent

public com.vaadin.flow.component.Component getContent()

Overrides:

getContent in class com.vaadin.flow.component.Composite<com.vaadin.flow.component.Component>

setHiliteOnHover

public void setHiliteOnHover(boolean hilite)

Hilite the content on hover by making the background to "var(--lumo-primary-color-50pct)".

Parameters:

hilite - True if needs to be hilited

setBorderRadius

public void setBorderRadius(int radius)

Set border radius.

Parameters:

radius - Radius in pixels

setBorderWidth

public void setBorderWidth(int widthInPixels)

Set border width.

Parameters:

widthInPixels - Width in pixels

setBorderWidth

public void setBorderWidth(String widths)

Set border width.

Parameters:

widths - Width

setBorderColor

public void setBorderColor(String color)

Set border color.

Parameters:

color - HTML color

setBorderStyle

public void setBorderStyle(String style)

Set border style.

Parameters:

style - Border style

setPadding

public void setPadding(int padding)

Set padding.

Parameters:

padding - Padding in pixels

setPadding

public void setPadding(String paddings)

Set padding.

Parameters:

paddings - Padding

setMargin

public void setMargin(int margin)

Set margin.

Parameters:

margin - Margin in pixels

setMargin

public void setMargin(String margins)

Set margin.

Parameters:

margins - Margin

setStyle

public void setStyle(String style,
 String value)

Directly set styles. For example, setStyle("margin", "3px")

Parameters:

style - Style to set

value - Value of the style

alignSizing

public void alignSizing()

Align the box in such way that total width/height of the box will be same as component's width/height. However, margin is still accounted for while computing the size.

setReadOnly

public void setReadOnly(boolean readOnly)

Set read only style. (Vaadin's Lumo theme is emulated).

Parameters:

readOnly - Read only flag

setEnabled

public void setEnabled(boolean enabled)

Set enabled/disabled style. (Vaadin's Lumo theme is emulated).

Parameters:

enabled - Enabled or not

grey

public void grey()

Create a grey background style. Same as setting setReadonly(true).