StringHierarchicalRenderer

com.phasmidsoftware.tableparser.core.render.HierarchicalRenderer.StringHierarchicalRenderer
See theStringHierarchicalRenderer companion object

A type class that provides functionality to render hierarchical data as strings.

The StringHierarchicalRenderer trait extends the UntaggedHierarchicalRenderer specifically for rendering data where the rendered output is of type String. This trait is the foundation for constructing string-based hierarchical renderings within a rendering framework.

It inherits the capabilities from UntaggedHierarchicalRenderer[String], where:

  • It allows objects of type T to be systematically converted into a string format with optional attributes that define characteristics of rendering.
  • It contains a default style attribute that can be used when rendering (defaults to an empty string).

By using StringHierarchicalRenderer, developers can define ways to represent data objects hierarchically in string form, while benefiting from shared behavior in the UntaggedHierarchicalRenderer parent trait.

Attributes

See also

UntaggedHierarchicalRenderer

HierarchicalRenderer

Companion
object
Graph
Supertypes
trait HierarchicalRenderer[String]
trait Renderer[String, Node]
class Object
trait Matchable
class Any
Show all
Known subtypes

Members list

Value members

Inherited methods

def asString(t: String): String

Method to render content as a String. This method is invoked only when T is not a Product, sequence or Option. Normally, the default method is what is required, but it might be necessary to override in some situations. This method does not apply to style or attribute values.

Method to render content as a String. This method is invoked only when T is not a Product, sequence or Option. Normally, the default method is what is required, but it might be necessary to override in some situations. This method does not apply to style or attribute values.

Value parameters

t

the content value.

Attributes

Returns

a String corresponding to t.

Inherited from:
HierarchicalRenderer
def render(t: String, attrs: Map[String, String]): Node

Render an instance of T as a U.

Render an instance of T as a U.

Value parameters

attrs

a map of attributes for this value of U.

t

the input parameter, i.e. the object to be rendered.

Attributes

Returns

a new instance of U.

Inherited from:
UntaggedHierarchicalRenderer
def render(t: String): Node

Render an instance of T as an O, qualifying the rendering with no attributes.

Render an instance of T as an O, qualifying the rendering with no attributes.

Value parameters

t

a T to be rendered.

Attributes

Returns

an instance of type O.

Inherited from:
Renderer

Inherited fields

val baseAttrs: Map[String, String]

Defines the base attribute set for type T.

Defines the base attribute set for type T.

Attributes

Inherited from:
HierarchicalRenderer
val style: String

Defines the default style for type T.

Defines the default style for type T.

Attributes

Inherited from:
UntaggedHierarchicalRenderer