de.xima.fc.gui.model

Class PlaceHolder

java.lang.Object

de.xima.fc.gui.model.PlaceHolder

All Implemented Interfaces:

Serializable, Comparable<PlaceHolder>

public class PlaceHolder
extends Object
implements Serializable, Comparable<PlaceHolder>

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PlaceHolder.PlaceHolderBuilder

Constructor Summary

Constructors

Constructor and Description
PlaceHolder(String name, EPlaceholderType type, String alias, String placeholder, String text, String icon, boolean empty)

Method Summary

Modifier and Type	Method and Description
int	compareTo(PlaceHolder other)
static PlaceHolder	empty(EPlaceholderType type)
String	getAlias()
String	getDetailedDescription(Locale locale)
String	getIcon()
String	getName()
String	getPlaceholder()
String	getShortDescription(Locale locale)
String	getText()
EPlaceholderType	getType()
boolean	isEmpty()
static PlaceHolder	normal(String name, EPlaceholderType type, String alias, String placeholder, String text, String icon)

Methods inherited from class java.lang.Object

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

Constructor Detail

PlaceHolder

public PlaceHolder(String name,
                   EPlaceholderType type,
                   String alias,
                   String placeholder,
                   String text,
                   String icon,
                   boolean empty)

Method Detail

getName

public String getName()

Returns:

Name of the placeolder, eg. CLIENT_ID.

getType

public EPlaceholderType getType()

Returns:

Type of this placeholder, eg. SYSTEM.

getAlias

public String getAlias()

Returns:

Only for form field placeholders: The alias of the form field.

getPlaceholder

public String getPlaceholder()

Returns:

Placeholder value without the bracket, eg. $$CLIENT_ID.

isEmpty

public boolean isEmpty()

getText

public String getText()

Returns:

Content of this placeholder.

getShortDescription

public String getShortDescription(Locale locale)

Parameters:

locale - Current locale.

Returns:

A short description that is shown for this placeholder, usually its name.

getDetailedDescription

public String getDetailedDescription(Locale locale)

Parameters:

locale - Current locale.

Returns:

Detailed description of this placeholder, such as explaning what it does for system placeholders.

getIcon

public String getIcon()

Returns:

Name of the icon for this placeholder.

normal

public static PlaceHolder normal(String name,
                                 EPlaceholderType type,
                                 String alias,
                                 String placeholder,
                                 String text,
                                 String icon)

empty

public static PlaceHolder empty(EPlaceholderType type)

compareTo

public int compareTo(PlaceHolder other)

Specified by:

compareTo in interface Comparable<PlaceHolder>

Parameters:

other - Other placeholder to which to compare this placeholder.

Returns:

Compare by type, then by name, then by alias.