ch.sahits.game.openpatrician.javafx.service

Class DecoratedTextFactory

java.lang.Object

ch.sahits.game.openpatrician.javafx.service.DecoratedTextFactory

public class DecoratedTextFactory
extends Object

Factory method to create a decorated text from a template.

Author:

Andi Hotz, (c) Sahits GmbH, 2014 Created on Nov 10, 2014

Field Summary

Fields

Modifier and Type	Field and Description
static String	BALE_ICON
static String	BARREL_ICON
static String	COIN_ICON
private IFontLoader	fontLoader
static String	GENERIC_ICON
static String	IMAGE
private SelectiveCachableXMLImageLoader	imageLoader
private int	leftInset
static String	SEGMENT_IMAGE
private int	topInset
private int	wrappingWidth

Constructor Summary

Constructors

Constructor and Description
DecoratedTextFactory(int leftInset, int topInset, int wrappingWidth)

Method Summary

Modifier and Type	Method and Description
DecoratedText	createDecoratedText(String template, Map<String,Object> parameters) Create a decorated text from the template string.
DecoratedText	createDecoratedText(String template, String styleClass, Map<String,Object> parameters) Create a decorated text from the template string.
javafx.scene.control.Label	createLabel(String template)
javafx.scene.layout.VBox	createMultiParagraphContainer()
private javafx.scene.shape.Shape	createSegmentedShape(double width, double heigth, List<Integer> visibleSegments)
DecoratedText	createSimpleDecoratedText(String template)
private DecoratedText	initializeDecoratedText(String template, Map<String,Object> parameters, DecoratedText text)
private boolean	isSpecialKey(String key)
private DecoratedText	replaceParameters(DecoratedText text, String template, Map<String,Object> parameters)
private DecoratedText	replaceSimpleParameter(DecoratedText text, Map<String,Object> parameters, String head, String tail, String key)
private String	replaceSimpleParameter(Map<String,Object> parameters, String head, String tail, String key)
private DecoratedText	replaceSpecialParameter(DecoratedText text, Map<String,Object> parameters, String tail, String key)
String	replaceTextParameters(String template, Map<String,Object> parameters) Replace the placeholders in the template with the values from the parameters object

Methods inherited from class java.lang.Object

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

Field Detail

COIN_ICON

public static final String COIN_ICON

See Also:

Constant Field Values

BARREL_ICON

public static final String BARREL_ICON

See Also:

Constant Field Values

BALE_ICON

public static final String BALE_ICON

See Also:

Constant Field Values

GENERIC_ICON

public static final String GENERIC_ICON

See Also:

Constant Field Values

SEGMENT_IMAGE

public static final String SEGMENT_IMAGE

See Also:

Constant Field Values

IMAGE

public static final String IMAGE

See Also:

Constant Field Values

leftInset

private final int leftInset

topInset

private final int topInset

wrappingWidth

private final int wrappingWidth

imageLoader

@Autowired
 @Qualifier(value="xmlImageLoader")
private SelectiveCachableXMLImageLoader imageLoader

fontLoader

@Autowired
private IFontLoader fontLoader

Constructor Detail

DecoratedTextFactory

public DecoratedTextFactory(int leftInset,
                            int topInset,
                            int wrappingWidth)

Method Detail

createMultiParagraphContainer

public javafx.scene.layout.VBox createMultiParagraphContainer()

createDecoratedText

public DecoratedText createDecoratedText(String template,
                                         Map<String,Object> parameters)

Create a decorated text from the template string. The template string can contain placeholders, that are replaced through objects in the parameters Map. The normal replacement uses the toString() method on the map entry's value. There are some special cases where a specific Node is created to represent the placeholder.
Special placeholders:

• icon:Coin: Coin icon followed by the amount passed in as parameter ([icon:Coin coinAmount])
• icon:Barrel: Barrel icon followed by the amount passed in as a parameter ([icon:Barrel amount])
• icon:Bale: Bale icon followed by the amount passed in as a parameter ([icon:Bale amount])
• icon:Generic: generic icon that is passed as parameter([icon:Generic icons/64/cannonball_icon]). The icon is scaled so it matches the line hight.
• image:Segment: segmented image split up in 9 segments and only the specified parts are visible ([image:Segment mapSegment1.png visibleSegments])
• image: centered image ([image imageName])

The amounts for Coin Barrel and Bale may also be already provided, e.g replaced as part of the message retrevial. In this case it is important that the amount is an unformatted integer. ([icon:Coin{0, number, #}]).

Parameters:

template - template string

parameters - Map containing the parameters.

Returns:

createLabel

public javafx.scene.control.Label createLabel(String template)

createSimpleDecoratedText

public DecoratedText createSimpleDecoratedText(String template)

initializeDecoratedText

private DecoratedText initializeDecoratedText(String template,
                                              Map<String,Object> parameters,
                                              DecoratedText text)

createDecoratedText

public DecoratedText createDecoratedText(String template,
                                         String styleClass,
                                         Map<String,Object> parameters)

Create a decorated text from the template string. The template string can contain placeholders, that are replaced through objects in the parameters Map. The normal replacement uses the toString() method on the map entry's value. There are some special cases where a specific Node is created to represent the placeholder.
Special placeholders:

• icon:Coin: Coin icon followed by the amount passed in as parameter ([icon:Coin coinAmount])
• icon:Barrel: Barrel icon followed by the amount passed in as a parameter ([icon:Barrel amount])
• icon:Bale: Bale icon followed by the amount passed in as a parameter ([icon:Bale amount])
• image:Segment: segmented image split up in 9 segments and only the specified parts are visible ([image:Segment mapSegment1.png visibleSegments])
• image: centered image ([image imageName])

The amounts for Coin Barrel and Bale may also be already provided, e.g replaced as part of the message retrevial. In this case it is important that the amount is an unformatted integer. ([icon:Coin{0, number, #}]).

Parameters:

template - template string

styleClass - style class from the base.css to be applied on the Decorated Text.

parameters - Map containing the parameters.

Returns:

replaceTextParameters

public String replaceTextParameters(String template,
                                    Map<String,Object> parameters)

Replace the placeholders in the template with the values from the parameters object

Parameters:

template - string containing placeholders

parameters - to replace the parameters

Returns:

finalized string

replaceParameters

private DecoratedText replaceParameters(DecoratedText text,
                                        String template,
                                        Map<String,Object> parameters)

replaceSpecialParameter

private DecoratedText replaceSpecialParameter(DecoratedText text,
                                              Map<String,Object> parameters,
                                              String tail,
                                              String key)

createSegmentedShape

private javafx.scene.shape.Shape createSegmentedShape(double width,
                                                      double heigth,
                                                      List<Integer> visibleSegments)

isSpecialKey

private boolean isSpecialKey(String key)

replaceSimpleParameter

private DecoratedText replaceSimpleParameter(DecoratedText text,
                                             Map<String,Object> parameters,
                                             String head,
                                             String tail,
                                             String key)

replaceSimpleParameter

private String replaceSimpleParameter(Map<String,Object> parameters,
                                      String head,
                                      String tail,
                                      String key)