Package squidpony.panel

Class IMarkup.StringMarkup

java.lang.Object

squidpony.panel.IMarkup.StringMarkup

All Implemented Interfaces:

IMarkup<String>

Enclosing interface:

IMarkup<T>

public static class IMarkup.StringMarkup
extends Object
implements IMarkup<String>

Probably not that useful on its own, but may be good as an example.

See Also:

IMarkup has more complete documentation on how it should be used

Nested Class Summary

Nested classes/interfaces inherited from interface squidpony.panel.IMarkup

IMarkup.StringMarkup

Constructor Summary

Constructors

Constructor	Description
StringMarkup()

Method Summary

Modifier and Type	Method	Description
String	closeMarkup()	Implementations should use this method to get a String that ends any section of markup currently ongoing.
String	getMarkup(String value)	Implementations should use this method to get a String that describes the given value, or begins some section of markup that uses a quality specified by value, such as a color or text size.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

StringMarkup

public StringMarkup()

Method Details

getMarkup

public String getMarkup(String value)

Description copied from interface: IMarkup

Implementations should use this method to get a String that describes the given value, or begins some section of markup that uses a quality specified by value, such as a color or text size.

Specified by:

getMarkup in interface IMarkup<String>

Parameters:

value - an object of type T that can be described by this IMarkup implementation

Returns:

a String either describing the value or starting a section of markup using the value.

closeMarkup

public String closeMarkup()

Description copied from interface: IMarkup

Implementations should use this method to get a String that ends any section of markup currently ongoing. This may be the empty String in many cases.

Specified by:

closeMarkup in interface IMarkup<String>

Returns:

the requisite String to end any ongoing sections of markup