com.phasmidsoftware.xmldoc.render
Members list
Type members
Classlikes
The BaseFormat abstract class provides a foundational implementation of common formatting operations, extending the Format trait. It includes methods and definitions for handling indentation, newline formatting, and rendering class names within a specific rendering state.
The BaseFormat abstract class provides a foundational implementation of common formatting operations, extending the Format trait. It includes methods and definitions for handling indentation, newline formatting, and rendering class names within a specific rendering state.
Value parameters
- indents
-
The number of indent levels to be used in formatting, affecting the structure of the formatted output.
Attributes
- Supertypes
- Known subtypes
The Format trait defines a blueprint for handling various formatting operations such as indentation, flattening, delimiters, sequencing, and line breaks. It is designed as a flexible interface to be implemented by specific formatting strategies.
The Format trait defines a blueprint for handling various formatting operations such as indentation, flattening, delimiters, sequencing, and line breaks. It is designed as a flexible interface to be implemented by specific formatting strategies.
Attributes
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass BaseFormattrait Formatclass Objecttrait Matchableclass AnyShow all
FormatText is a case class that extends the functionality of BaseFormat for text-based formatting purposes. It provides mechanisms for handling hierarchical indentation, formatting class names within a rendering state, and generating sequences or enclosed structures based on an open/close state.
FormatText is a case class that extends the functionality of BaseFormat for text-based formatting purposes. It provides mechanisms for handling hierarchical indentation, formatting class names within a rendering state, and generating sequences or enclosed structures based on an open/close state.
Value parameters
- indents
-
The number of initial indentation levels to apply.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass BaseFormattrait Formatclass Objecttrait Matchableclass AnyShow all
Companion object for the FormatXML class.
The FormatXML case class provides a specialized implementation for formatting content in XML-like structures. It inherits from BaseFormat and offers additional functionality for handling XML-specific formatting operations, including indentation, flattening, delimiters, and opening/closing tag formatting.
The FormatXML case class provides a specialized implementation for formatting content in XML-like structures. It inherits from BaseFormat and offers additional functionality for handling XML-specific formatting operations, including indentation, flattening, delimiters, and opening/closing tag formatting.
Value parameters
- flat
-
A boolean flag indicating whether the format should be flattened, eliminating structural indentation.
- indents
-
The number of indentation levels to be applied in formatting.
Attributes
- Companion
- object
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass BaseFormattrait Formatclass Objecttrait Matchableclass AnyShow all
Typeclass to specify the required behavior of an object that you want to render as a String.
Typeclass to specify the required behavior of an object that you want to render as a String.
Type parameters
- T
-
the type of the object.
Attributes
- Companion
- object
- Supertypes
Utility object for working with the Renderer typeclass. Provides methods to build, manipulate, and use instances of Renderer for rendering various types as strings.
Trait which defines generic and standard renderers.
Trait which defines generic and standard renderers.
Attributes
- Companion
- object
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
-
object AbstractViewobject AbstractViewDataobject Aliasobject Altitudeobject AltitudeModeobject AltitudeModeEnumobject AxisScaleobject BalloonStyleobject BgColorobject Cameraobject Colorobject ColorModeobject ColorModeEnumobject ColorStyleobject ColorStyleDataobject Containerobject ContainerDataobject Coordinatesobject Dataobject DisplayModeobject DisplayModeEnumobject Documentobject DrawOrderobject ExtendedDataobject Extrudeobject Featureobject FeatureDataobject Fillobject FlyToViewobject Folderobject Geometryobject GeometryDataobject GroundOverlayobject Headingobject HotSpotobject Iconobject IconStyleobject ImagePyramidobject InnerBoundaryIsobject ItemIconobject ItemIconModeEnumobject KMLobject Keyobject KmlDataobject KmlRenderersobject LabelStyleobject LatLonBoxobject Latitudeobject LineStringobject LineStyleobject LinearRingobject Linkobject ListItemTypeobject ListItemTypeEnumobject ListStyleobject Locationobject Longitudeobject LookAtobject Modelobject ModelScaleobject MultiGeometryobject NetworkLinkobject Openobject Orientationobject OuterBoundaryIsobject Outlineobject Overlayobject OverlayDataobject OverlayXYobject Pairobject PhotoOverlayobject Placemarkobject Pointobject PolyStyleobject Polygonobject Rangeobject RefreshIntervalobject RefreshModeobject RefreshModeEnumobject RefreshVisibilityobject ResourceMapobject Rollobject Rotationobject RotationXYobject Scaleobject SchemaDataobject ScreenOverlayobject ScreenXYobject Shapeobject ShapeEnumobject SimpleDataobject Sizeobject Stateobject Styleobject StyleSelectorobject StyleSelectorDataobject StyleStateEnumobject StyleURLobject SubStyleobject SubStyleDataobject Tessellateobject TextColorobject Tiltobject UnitsEnumobject ViewBoundScaleobject ViewRefreshEnumobject ViewRefreshModeobject ViewRefreshTimeobject ViewVolumeobject Visibilityobject WidthShow all
Object containing various Renderer instances and utility methods for rendering objects into string representations with optional attributes and specific formatting rules.
The StateR companion object provides factory methods for creating instances of the StateR class. These methods allow for the creation of a StateR instance either with a specified name or with no name.
The StateR companion object provides factory methods for creating instances of the StateR class. These methods allow for the creation of a StateR instance either with a specified name or with no name.
Attributes
Case class intended to take care of the state of rendering. Rendering is complex for several reasons: (1) a method such as render5 invokes render4, render3, etc. in order to process all of the members of a Product. (2) attributes are special and need to be rendered within the opening tag of the top-level element.
Case class intended to take care of the state of rendering. Rendering is complex for several reasons: (1) a method such as render5 invokes render4, render3, etc. in order to process all of the members of a Product. (2) attributes are special and need to be rendered within the opening tag of the top-level element.
NOTE: attributes is mutable (it's a SmartBuffer). It is retained as we do operations such as setName, recurse. However, we must be careful to ensure that no attribute gets left behind.
Value parameters
- attributes
-
a (private) SmartBuffer: accessible via addAttribute or getAttributes.
- interior
-
false if we are at the top level of an element; true if we have been invoked from above.
- maybeName
-
an optional String.
Attributes
- Companion
- object
- Supertypes
-
trait Serializabletrait Producttrait Equalstrait AutoCloseableclass Objecttrait Matchableclass AnyShow all