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

Modifier and Type	Field and Description
private final BorderChars	borderChars
private final FrameConfiguration	configuration
private static final int	NO_WIDTH_SET
private final List<FrameNode>	nodes
private static final String	NULL_FRAME_ALIGN
private String	title
private FrameAlign	titleAlign
private final BoxType	type
private int	width

Access	Constructor and Description
public	Frame(FrameConfiguration configuration, BoxType type)
public	Frame()
public	Frame(BoxType type)
public	Frame(FrameConfiguration configuration)

Method Summary

Modifier and Type	Method and Description
pack-priv void	align(FrameNode node, int availableWidth, StringBuilder sb)
pack-priv void	appendTitleToBox(Cell parsedTitle, int givenWidth, int titleWidth, StringBuilder sb)
pack-priv void	assertNotSelf(Component component)
pack-priv void	colorBorders(BorderChars borderChar)
public boolean	equals(Object object) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
pack-priv int	findNodesMaxWidth()
pack-priv static int	findTitleBlockOffset(int givenWidth, int titleWidth, FrameAlign align)
public String	Returns: the fully rendered frame as a multi-line string, terminated with a newline get() Implements io.github.kusoroadeolu.clique.components.Component.get. Builds the frame and all its nested nodes to a string.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public Frame	Returns: this frame, for chaining nest(String the string to nest; must not be `null` str) Appends a string node to this frame using the alignment configured in `FrameConfiguration`.
public Frame	Returns: this frame, for chaining nest(String the string to nest; must not be `null` str, FrameAlign the horizontal alignment of the string within the frame; must not be `null` align) Appends a string node to this frame with the specified alignment.
public Frame	Returns: this frame, for chaining nest(Component the component to nest; must not be `null` and must not be this frame component) Appends a `Component` node to this frame using the alignment configured in `FrameConfiguration`.
public Frame	Returns: this frame, for chaining nest(Component the component to nest; must not be `null` and must not be this frame component, FrameAlign the horizontal alignment within the frame; must not be `null` align) Appends a `Component` node to this frame with the specified alignment.
pack-priv boolean	noWidthSet()
public Frame	Returns: this frame, for chaining title(String the title text; must not be `null` title, FrameAlign the horizontal placement of the title; must not be `null` titleAlign) Sets the frame title and its horizontal alignment within the top border.
public Frame	Returns: this frame, for chaining title(String the title text; must not be `null` title) Sets the frame title with center alignment.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
pack-priv void	validateTitleWidth(int titleWidth, int resolvedWidth)
public Frame	Returns: this frame, for chaining width(int the total inner width; must be greater than zero width) Sets the total inner width of the frame in characters, excluding the border columns.

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

borderChars	back to summary
private final BorderChars borderChars

configuration	back to summary
private final FrameConfiguration configuration

NO_WIDTH_SET	back to summary
private static final int NO_WIDTH_SET

nodes	back to summary
private final List<FrameNode> nodes

NULL_FRAME_ALIGN	back to summary
private static final String NULL_FRAME_ALIGN

title	back to summary
private String title

titleAlign	back to summary
private FrameAlign titleAlign

type	back to summary
private final BoxType type

width	back to summary
private int width

Frame	back to summary
public Frame(FrameConfiguration configuration, BoxType type)

Frame	back to summary
public Frame()

Frame	back to summary
public Frame(BoxType type)

Frame	back to summary
public Frame(FrameConfiguration configuration)

Method Detail

align	back to summary
pack-priv void align(FrameNode node, int availableWidth, StringBuilder sb)

appendTitleToBox	back to summary
pack-priv void appendTitleToBox(Cell parsedTitle, int givenWidth, int titleWidth, StringBuilder sb)

assertNotSelf	back to summary
pack-priv void assertNotSelf(Component component)

colorBorders	back to summary
pack-priv void colorBorders(BorderChars borderChar)

equals back to summary

equals	back to summary
public boolean equals(Object object) 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 object)

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

findNodesMaxWidth	back to summary
pack-priv int findNodesMaxWidth()

findTitleBlockOffset	back to summary
pack-priv static int findTitleBlockOffset(int givenWidth, int titleWidth, FrameAlign align)

get	back to summary
public String get() Implements io.github.kusoroadeolu.clique.components.Component.get. Builds the frame and all its nested nodes to a string. Width resolution, title placement, content alignment, and border drawing all occur during this call. No state is cached; each invocation performs a full render. Returns:String the fully rendered frame as a multi-line string, terminated with a newline Exceptions InvalidDimensionException: if the title width exceeds the resolved frame width, or if any nested node's content width exceeds the available content area

get

back to summary

public String get()

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

Builds the frame and all its nested nodes to a string.

Width resolution, title placement, content alignment, and border drawing all occur during this call. No state is cached; each invocation performs a full render.

Returns:String

the fully rendered frame as a multi-line string, terminated with a newline

Exceptions

InvalidDimensionException:: if the title width exceeds the resolved frame width, or if any nested node's content width exceeds the available content area

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

nest back to summary

nest	back to summary
public Frame nest(String str) Appends a string node to this frame using the alignment configured in `FrameConfiguration`. Equivalent to `nest(str, configuration.getFrameAlign())`. Parameters str:String the string to nest; must not be `null` Returns:Frame this frame, for chaining Exceptions NullPointerException: if `str` is `null`

public Frame nest(String str)

Appends a string node to this frame using the alignment configured in FrameConfiguration.

Equivalent to nest(str, configuration.getFrameAlign()).

Parameters

str:String: the string to nest; must not be null

Returns:Frame

this frame, for chaining

Exceptions

NullPointerException:: if str is null

nest back to summary

nest	back to summary
public Frame nest(String str, FrameAlign align) Appends a string node to this frame with the specified alignment. Parameters str:String the string to nest; must not be `null` align:FrameAlign the horizontal alignment of the string within the frame; must not be `null` Returns:Frame this frame, for chaining Exceptions NullPointerException: if `str` or `align` is `null`

public Frame nest(String str, FrameAlign align)

Appends a string node to this frame with the specified alignment.

Parameters

str:String: the string to nest; must not be null
align:FrameAlign: the horizontal alignment of the string within the frame; must not be null

Returns:Frame

this frame, for chaining

Exceptions

NullPointerException:: if str or align is null

nest back to summary

nest	back to summary
public Frame nest(Component component) Appends a `Component` node to this frame using the alignment configured in `FrameConfiguration`. Equivalent to `nest(component, configuration.getFrameAlign())`. Parameters component:Component the component to nest; must not be `null` and must not be this frame Returns:Frame this frame, for chaining Exceptions NullPointerException: if `component` is `null` IllegalArgumentException: if `component` is this frame instance

public Frame nest(Component component)

Appends a Component node to this frame using the alignment configured in FrameConfiguration.

Equivalent to nest(component, configuration.getFrameAlign()).

Parameters

component:Component: the component to nest; must not be null and must not be this frame

Returns:Frame

this frame, for chaining

Exceptions

NullPointerException:: if component is null
IllegalArgumentException:: if component is this frame instance

nest back to summary

nest	back to summary
public Frame nest(Component component, FrameAlign align) Appends a `Component` node to this frame with the specified alignment. A frame cannot nest itself. Attempting to do so throws `IllegalArgumentException`. Circular nesting through intermediate components is not detected and results in a `StackOverflowError` at render time. Parameters component:Component the component to nest; must not be `null` and must not be this frame align:FrameAlign the horizontal alignment within the frame; must not be `null` Returns:Frame this frame, for chaining Exceptions NullPointerException: if `component` or `align` is `null` IllegalArgumentException: if `component` is this frame instance

public Frame nest(Component component, FrameAlign align)

Appends a Component node to this frame with the specified alignment.

A frame cannot nest itself. Attempting to do so throws IllegalArgumentException. Circular nesting through intermediate components is not detected and results in a StackOverflowError at render time.

Parameters

component:Component: the component to nest; must not be null and must not be this frame
align:FrameAlign: the horizontal alignment within the frame; must not be null

Returns:Frame

this frame, for chaining

Exceptions

NullPointerException:: if component or align is null
IllegalArgumentException:: if component is this frame instance

noWidthSet	back to summary
pack-priv boolean noWidthSet()

title back to summary

title	back to summary
public Frame title(String title, FrameAlign titleAlign) Sets the frame title and its horizontal alignment within the top border. The title is rendered inline with the top border line. If a color parser is configured, a reset sequence is automatically appended to prevent color bleed into the border. Parameters title:String the title text; must not be `null` titleAlign:FrameAlign the horizontal placement of the title; must not be `null` Returns:Frame this frame, for chaining Exceptions NullPointerException: if `title` or `titleAlign` is `null` InvalidDimensionException: if the title is wider than the resolved frame width, thrown at render time via `get()`

public Frame title(String title, FrameAlign titleAlign)

Sets the frame title and its horizontal alignment within the top border.

The title is rendered inline with the top border line. If a color parser is configured, a reset sequence is automatically appended to prevent color bleed into the border.

Parameters

title:String: the title text; must not be null
titleAlign:FrameAlign: the horizontal placement of the title; must not be null

Returns:Frame

this frame, for chaining

Exceptions

NullPointerException:: if title or titleAlign is null
InvalidDimensionException:: if the title is wider than the resolved frame width, thrown at render time via get()

title back to summary

title	back to summary
public Frame title(String title) Sets the frame title with center alignment. Equivalent to `title(title, FrameAlign.CENTER)`. Parameters title:String the title text; must not be `null` Returns:Frame this frame, for chaining Exceptions NullPointerException: if `title` is `null`

public Frame title(String title)

Sets the frame title with center alignment.

Equivalent to title(title, FrameAlign.CENTER).

Parameters

title:String: the title text; must not be null

Returns:Frame

this frame, for chaining

Exceptions

NullPointerException:: if title is null

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

validateTitleWidth	back to summary
pack-priv void validateTitleWidth(int titleWidth, int resolvedWidth)

width back to summary

width	back to summary
public Frame width(int width) Sets the total inner width of the frame in characters, excluding the border columns. When set, this width overrides auto-sizing. The available content width is `width - (padding * 2)`. Nested node widths must not exceed this value; violations are detected at render time via `get()`. Parameters width:int the total inner width; must be greater than zero Returns:Frame this frame, for chaining Exceptions InvalidDimensionException: if `width` is less than or equal to zero

public Frame width(int width)

Sets the total inner width of the frame in characters, excluding the border columns.

When set, this width overrides auto-sizing. The available content width is width - (padding * 2). Nested node widths must not exceed this value; violations are detected at render time via get().

Parameters

width:int: the total inner width; must be greater than zero

Returns:Frame

this frame, for chaining

Exceptions

InvalidDimensionException:: if width is less than or equal to zero

public Class Frame

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail