FormatCoordinate

com.phasmidsoftware.xmldoc.kml.KmlRenderers.FormatCoordinate
case class FormatCoordinate(indents: Int) extends BaseFormat

FormatCoordinate is a case class for handling coordinate-specific formatting in KML rendering. It extends the BaseFormat abstraction, inheriting core formatting behavior while specializing in coordinate-related formatting operations.

Value parameters

indents

The number of indentation levels used for formatting.

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class BaseFormat
trait Format
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

def formatName[T : ClassTag](open: Option[Boolean], stateR: StateR): String

Formats the name based on the given state and an optional flag.

Formats the name based on the given state and an optional flag.

Type parameters

T

a type parameter with an implicit ClassTag, allowing runtime inspection of type T.

Value parameters

open

an optional Boolean value. If Some(true), specific formatting is performed; otherwise, a default behavior is applied.

stateR

the rendering state represented by the StateR instance, which provides context for formatting.

Attributes

Returns

a formatted string based on the input parameters and formatting logic.

def indent: Format

Returns the current instance of the Format, as it represents the same formatting configuration.

Returns the current instance of the Format, as it represents the same formatting configuration.

Attributes

Returns

the current Format instance with unchanged characteristics.

def sequencer(open: Option[Boolean]): String

Determines the sequence string based on an optional Boolean input.

Determines the sequence string based on an optional Boolean input.

Value parameters

open

An Option of Boolean indicating the desired state. If Some(true), a newline with the specified indentation is returned. If Some(false), an empty string is returned. If None, a single newline character is returned.

Attributes

Returns

A string representing the appropriate sequence based on the input parameter.

Inherited methods

def delimiter: String

Retrieves the default delimiter used for separating elements in formatted content.

Retrieves the default delimiter used for separating elements in formatted content.

Attributes

Returns

A String representing the default delimiter, typically a comma followed by a space (", ").

Inherited from:
Format

Returns this Format unaffected..

Returns this Format unaffected..

Attributes

Returns

The current Format instance, representing the flat version of the format.

Inherited from:
BaseFormat
def newline: String

Generates a newline character followed by a string of spaces based on the current indent level. The indentation is determined by the number of indents multiplied by a predefined tab unit.

Generates a newline character followed by a string of spaces based on the current indent level. The indentation is determined by the number of indents multiplied by a predefined tab unit.

Attributes

Returns

A formatted string consisting of a newline character followed by the appropriate level of indentation.

Inherited from:
BaseFormat
def productElementNames: Iterator[String]

An iterator over the names of all the elements of this product.

An iterator over the names of all the elements of this product.

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

An iterator over all the elements of this product.

An iterator over all the elements of this product.

Attributes

Returns

in the default implementation, an Iterator[Any]

Inherited from:
Product

Concrete fields

val name: String

Represents the name associated with the BaseFormat class or its subclasses. It is expected to provide an identity or label that can be utilized in formatting operations or for rendering purposes within the implementation.

Represents the name associated with the BaseFormat class or its subclasses. It is expected to provide an identity or label that can be utilized in formatting operations or for rendering purposes within the implementation.

Attributes