Package de.xima.fc.gui.common.placeholder

Class GenericTextFragment

java.lang.Object

de.xima.fc.gui.common.placeholder.PlaceHolder

de.xima.fc.gui.common.placeholder.GenericTextFragment

All Implemented Interfaces:

IPlaceholder, Serializable

public class GenericTextFragment
extends PlaceHolder

PlaceHolder implementation for plain or HTML text fragments (e.g. to make them manageable by the placeholder dialog).

Since:

8.4.1

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class de.xima.fc.gui.common.placeholder.PlaceHolder

PlaceHolder.PlaceHolderBuilder

Field Summary

Fields inherited from interface de.xima.fc.gui.common.placeholder.IPlaceholder

LINK_RECOGNITION_PATTERN

Method Summary

Modifier and Type	Method	Description
static PlaceHolder	fromTemplate(Textbaustein template, String groupName, boolean untagged, IGuiIcon icon, EPlaceholderInsertHint insertHint)	Creates a PlaceHolder instance based on the properties of a template.
EPlaceholderInsertHint	getInsertHint()	The preferred way for this text fragment to be inserted into input elements, although this might not be supported by all target components.
String	getPlaceholder()	Gets the full placeholder name with the brackets, e.g.

Methods inherited from class de.xima.fc.gui.common.placeholder.PlaceHolder

comparator, empty, equals, formLang, formXfAction, formXfQualifier, getAlias, getDetailedDescription, getDisplayName, getIcon, getIconStyleClass, getIconValue, getKind, getName, getShortDescription, getSortKey, getText, getType, hashCode, isEmpty, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getPlaceholder

public String getPlaceholder()

Description copied from interface: IPlaceholder

Gets the full placeholder name with the brackets, e.g. [%$CLIENT_ID%]. Used when inserting the placeholder in an input field

Specified by:

getPlaceholder in interface IPlaceholder

Overrides:

getPlaceholder in class PlaceHolder

Returns:

The full placeholder name including brackets.

getInsertHint

public EPlaceholderInsertHint getInsertHint()

Description copied from interface: IPlaceholder

The preferred way for this text fragment to be inserted into input elements, although this might not be supported by all target components.

The default implementation behaves as follows: If the placeholder starts with "LINK_", ends with "_LINK", or contains "_LINK_" or "_LINK." returns LINK. Otherwise, returns TEXT.

Specified by:

getInsertHint in interface IPlaceholder

Overrides:

getInsertHint in class PlaceHolder

Returns:

The preferred insert mode for this text fragment.

fromTemplate

public static PlaceHolder fromTemplate(Textbaustein template,
                                       String groupName,
                                       boolean untagged,
                                       IGuiIcon icon,
                                       EPlaceholderInsertHint insertHint)

Creates a PlaceHolder instance based on the properties of a template.

Parameters:

template - the template to create the text fragment from

groupName - a string for text fragment grouping (e.g. in datatables)

untagged - true, if the provided template doesn't have any keywords/tags

icon - an icon to be used for this text fragment in the GUI

insertHint - describes the way this text fragment prefers to be inserted. Might not be supported by all target components.

Returns:

The new PlaceHolder instance