com.whitestein.lsps.vaadin.util

Class Hints.Size

java.lang.Object

com.whitestein.lsps.vaadin.util.Hints.Size

Enclosing class:

Hints

public abstract static class Hints.Size
extends Object

Queries/sets width/height of a Vaadin component.

Constructor Summary

Constructors

Constructor and Description
Size()

Method Summary

Modifier and Type	Method and Description
abstract float	getSize() Returns Sizeable.getWidth() or Sizeable.getHeight().
abstract com.vaadin.server.Sizeable.Unit	getSizeUnits() Returns Sizeable.getWidthUnits() or Sizeable.getHeightUnits().
static Hints.Size	heightOf(com.vaadin.server.Sizeable component) Provides access to component height.
boolean	isFillParent() Checks whether the component fills its parent completely.
boolean	isFillParentPartially() Checks whether the component fills its parent at least partially.
boolean	isPercentage() Checks whether the component fills some percentage portion of parent.
boolean	isWrapContent() Checks whether the component wraps its children.
Hints.Size	set100Percent() Sets the size to 100%.
Hints.Size	setFillParent() Configures the component to fill its parent completely.
Hints.Size	setHintValue(Variant<?> newValue) Sets the size based on a hint value.
abstract void	setSize(float size, com.vaadin.server.Sizeable.Unit unit) Calls Sizeable.setWidth(float, com.vaadin.server.Sizeable.Unit) or Sizeable.setHeight(float, com.vaadin.server.Sizeable.Unit).
abstract void	setSize(String size) Calls Sizeable.setWidth(String) or Sizeable.setHeight(String).
Hints.Size	setWrapContent() Configures the component to wrap its children (sets the size to -1 pixels).
String	toString()
static Hints.Size	widthOf(com.vaadin.server.Sizeable component) Provides access to component width.

Methods inherited from class java.lang.Object

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

Constructor Detail

Size

public Size()

Method Detail

getSize

public abstract float getSize()

Returns Sizeable.getWidth() or Sizeable.getHeight().

Returns:

the size

getSizeUnits

public abstract com.vaadin.server.Sizeable.Unit getSizeUnits()

Returns Sizeable.getWidthUnits() or Sizeable.getHeightUnits().

Returns:

size units, not null.

setSize

public abstract void setSize(float size,
                             com.vaadin.server.Sizeable.Unit unit)

Calls Sizeable.setWidth(float, com.vaadin.server.Sizeable.Unit) or Sizeable.setHeight(float, com.vaadin.server.Sizeable.Unit).

Parameters:

size - the width or height

unit - the unit, not null.

setSize

public abstract void setSize(String size)

Calls Sizeable.setWidth(String) or Sizeable.setHeight(String).

Parameters:

size - the new size, may be null.

widthOf

public static Hints.Size widthOf(com.vaadin.server.Sizeable component)

Provides access to component width.

Parameters:

component - the component, not null.

Returns:

accessor, never null.

heightOf

public static Hints.Size heightOf(com.vaadin.server.Sizeable component)

Provides access to component height.

Parameters:

component - the component, not null.

Returns:

accessor, never null.

isWrapContent

public boolean isWrapContent()

Checks whether the component wraps its children.

Returns:

true if the component wraps its children (getSize() is less than zero.

setWrapContent

public Hints.Size setWrapContent()

Configures the component to wrap its children (sets the size to -1 pixels).

Returns:

this

isFillParent

public boolean isFillParent()

Checks whether the component fills its parent completely.

Returns:

true if the component size is set to 100%

isFillParentPartially

public boolean isFillParentPartially()

Checks whether the component fills its parent at least partially.

Returns:

true if the component size is set to x%

setFillParent

public Hints.Size setFillParent()

Configures the component to fill its parent completely. Equals to set100Percent().

Returns:

this

isPercentage

public boolean isPercentage()

Checks whether the component fills some percentage portion of parent.

Returns:

true if the size is 0 or more percent, false otherwise.

set100Percent

public Hints.Size set100Percent()

Sets the size to 100%. Equal to setFillParent().

Returns:

this

setHintValue

public Hints.Size setHintValue(Variant<?> newValue)

Sets the size based on a hint value. Processes "fill-parent" and "wrap-content" correctly.

Parameters:

newValue - the new value, not null. May be absent.

Returns:

this

toString

public String toString()

Overrides:

toString in class Object