Clique 4.0.3 · io.github.kusoroadeolu.clique.components.Box

Modifier and Type	Field and Description
private TextAlign	align
private final BorderChars	borderChars
private static final String	BOX_CONTENT_NOT_NULL
private String	cachedString
private final BoxConfiguration	configuration
private String	content
private int	height
private static final String	TEXT_ALIGN_NOT_NULL
private int	width

Access	Constructor and Description
public	Box(BoxType type, BoxConfiguration configuration)
public	Box(BoxType type)
public	Box(BoxConfiguration configuration)
public	Box()

Method Summary

Modifier and Type	Method and Description
public Box	Returns: this box instance content(String the text content to display; must not be `null` content) Sets the content of this box and invalidates the render cache.
public Box	Returns: this box instance content(String the text content to display; must not be `null` content, TextAlign the text alignment to apply; must not be `null` align) Sets the content and text alignment of this box, invalidating the render cache.
public Box	Returns: this box instance dimensions(int the total outer width of the box; must be greater than 0 width, int the total outer height of the box; must be greater than 0 height) Sets explicit dimensions for this box.
public boolean	equals(Object o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public String	Returns: the rendered box as a string get() Implements io.github.kusoroadeolu.clique.components.Component.get. Renders and returns the box as a string.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
private void	nullCachedString()
private void	resolveDimensions(WidthAwareList cells)
pack-priv WidthAwareList	resolveLines()
pack-priv void	styleBorders()
pack-priv TextAlign	textAlign()
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
pack-priv void	validateTypeAndConfig(BoxType type, BoxConfiguration config)

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

align	back to summary
private TextAlign align

borderChars	back to summary
private final BorderChars borderChars

BOX_CONTENT_NOT_NULL	back to summary
private static final String BOX_CONTENT_NOT_NULL

cachedString	back to summary
private String cachedString

configuration	back to summary
private final BoxConfiguration configuration

content	back to summary
private String content

height	back to summary
private int height

TEXT_ALIGN_NOT_NULL	back to summary
private static final String TEXT_ALIGN_NOT_NULL

width	back to summary
private int width

Box	back to summary
public Box(BoxType type, BoxConfiguration configuration)

Box	back to summary
public Box(BoxType type)

Box	back to summary
public Box(BoxConfiguration configuration)

Box	back to summary
public Box()

Method Detail

content back to summary

content	back to summary
public Box content(String content) Sets the content of this box and invalidates the render cache. Text alignment is inherited from the `BoxConfiguration` provided at construction time. Parameters content:String the text content to display; must not be `null` Returns:Box this box instance Exceptions NullPointerException: if `content` is `null`

public Box content(String content)

Sets the content of this box and invalidates the render cache.

Text alignment is inherited from the BoxConfiguration provided at construction time.

Parameters

content:String: the text content to display; must not be null

Returns:Box

this box instance

Exceptions

NullPointerException:: if content is null

content back to summary

content	back to summary
public Box content(String content, TextAlign align) Sets the content and text alignment of this box, invalidating the render cache. The provided `align` takes precedence over the alignment specified in the `BoxConfiguration`. Parameters content:String the text content to display; must not be `null` align:TextAlign the text alignment to apply; must not be `null` Returns:Box this box instance Exceptions NullPointerException: if `content` or `align` is `null`

public Box content(String content, TextAlign align)

Sets the content and text alignment of this box, invalidating the render cache.

The provided align takes precedence over the alignment specified in the BoxConfiguration.

Parameters

content:String: the text content to display; must not be null
align:TextAlign: the text alignment to apply; must not be null

Returns:Box

this box instance

Exceptions

NullPointerException:: if content or align is null

dimensions back to summary

dimensions	back to summary
public Box dimensions(int width, int height) Sets explicit dimensions for this box. When dimensions are set, content that exceeds the usable inner width (width minus padding) or the specified height will throw an `InvalidDimensionException` at render time. If this method is never called, the box auto sizes to fit its content. Parameters width:int the total outer width of the box; must be greater than 0 height:int the total outer height of the box; must be greater than 0 Returns:Box this box instance Exceptions IllegalArgumentException: if `width` or `height` is not greater than 0

public Box dimensions(int width, int height)

Sets explicit dimensions for this box.

When dimensions are set, content that exceeds the usable inner width (width minus padding) or the specified height will throw an InvalidDimensionException at render time. If this method is never called, the box auto sizes to fit its content.

Parameters

width:int: the total outer width of the box; must be greater than 0
height:int: the total outer height of the box; must be greater than 0

Returns:Box

this box instance

Exceptions

IllegalArgumentException:: if width or height is not greater than 0

equals back to summary

equals	back to summary
public boolean equals(Object o) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Annotations @Override

public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Annotations

@Override

get back to summary

get	back to summary
public String get() Implements io.github.kusoroadeolu.clique.components.Component.get. Renders and returns the box as a string. The result is cached after the first invocation and reused on subsequent calls until the content is updated. Text alignment is resolved from the per-call override set via `content(String, TextAlign)` if present, falling back to the value in `BoxConfiguration`. Returns:String the rendered box as a string

public String get()

Implements io.github.kusoroadeolu.clique.components.Component.get.

Renders and returns the box as a string.

The result is cached after the first invocation and reused on subsequent calls until the content is updated. Text alignment is resolved from the per-call override set via content(String, TextAlign) if present, falling back to the value in BoxConfiguration.

Returns:String: the rendered box as a string

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Annotations

@Override

nullCachedString	back to summary
private void nullCachedString()

resolveDimensions	back to summary
private void resolveDimensions(WidthAwareList cells)

resolveLines	back to summary
pack-priv WidthAwareList resolveLines()

styleBorders	back to summary
pack-priv void styleBorders()

textAlign	back to summary
pack-priv TextAlign textAlign()

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations

@Override

validateTypeAndConfig	back to summary
pack-priv void validateTypeAndConfig(BoxType type, BoxConfiguration config)

public Class Box

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail