Package ca.corbett.extras.properties

Class HtmlLabelProperty

java.lang.Object

ca.corbett.extras.properties.AbstractProperty

ca.corbett.extras.properties.HtmlLabelProperty

public class HtmlLabelProperty
extends AbstractProperty

Represents an html label, which can have multiple hyperlinks with custom actions. Labels are static form fields, so they do not save or load anything to or from properties.

USAGE: Refer to the HtmlLabelField class for detailed usage instructions. Basically, you must supply the html-formatted label text, and an Action which will be triggered when any of the hyperlinks are clicked.

Since:

swing-extras 2.6

Author:

scorbo2

Field Summary

Fields inherited from class ca.corbett.extras.properties.AbstractProperty

categoryName, DEFAULT_CATEGORY, DEFAULT_PROPERTY_NAME, extraAttributes, fullyQualifiedName, helpText, isEnabled, isExposed, isInitiallyEditable, isInitiallyVisible, marginPadding, propertyLabel, propertyName, subCategoryName

Constructor Summary

Constructors

Constructor	Description
HtmlLabelProperty(String name, String fieldLabel, String labelHtml, Action linkAction)
HtmlLabelProperty(String name, String labelHtml, Action linkAction)

Method Summary

Modifier and Type	Method	Description
protected FormField	generateFormFieldImpl()	Descendant classes must implement this method to generate a FormField associated with this property.
String	getHtml()
Action	getLinkAction()
boolean	isAllowsUserInput()	Most properties generate FormField instances that allow user input, but we do not:
void	loadFromFormField(FormField field)	Populates this Property's value(s) from the given form field, assuming the field is of the correct type.
void	loadFromProps(Properties props)	Loads the value(s) for this property from the given Properties instance, overwriting any current value.
void	saveToProps(Properties props)	Saves the current value(s) of this property to the given Properties instance.
void	setHtml(String html, Action linkAction)

Methods inherited from class ca.corbett.extras.properties.AbstractProperty

addAllExtraAttributes, addBottomPadding, addFormFieldChangeListener, addFormFieldGenerationListener, addInnerPadding, addLeftPadding, addPadding, addRightPadding, addTopPadding, clearExtraAttribute, clearExtraAttributes, equals, fireFormFieldChangedEvent, fireFormFieldGeneratedEvent, generateFormField, generateFormField, getCategoryName, getExtraAttribute, getFullyQualifiedName, getHelpText, getMarginPadding, getPropertyLabel, getPropertyName, getSubCategoryName, hashCode, isEnabled, isExposed, isInitiallyEditable, isInitiallyVisible, removeAllFormFieldChangeListeners, removeAllFormFieldGenerationListeners, removeFormFieldChangeListener, removeFormFieldGenerationListener, setAllExtraAttributes, setEnabled, setExposed, setExtraAttribute, setHelpText, setInitiallyEditable, setInitiallyVisible, setPropertyLabel

Methods inherited from class java.lang.Object

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

Constructor Details

HtmlLabelProperty

public HtmlLabelProperty(String name,
 String labelHtml,
 Action linkAction)

HtmlLabelProperty

public HtmlLabelProperty(String name,
 String fieldLabel,
 String labelHtml,
 Action linkAction)

Method Details

isAllowsUserInput

public boolean isAllowsUserInput()

Most properties generate FormField instances that allow user input, but we do not:

Overrides:

isAllowsUserInput in class AbstractProperty

Returns:

false, to indicate that we are effectively read-only.

getLinkAction

public Action getLinkAction()

getHtml

public String getHtml()

setHtml

public void setHtml(String html,
 Action linkAction)

saveToProps

public void saveToProps(Properties props)

Description copied from class: AbstractProperty

Saves the current value(s) of this property to the given Properties instance.

Specified by:

saveToProps in class AbstractProperty

Parameters:

props - Any Properties instance which will receive the value(s) of this property.

loadFromProps

public void loadFromProps(Properties props)

Description copied from class: AbstractProperty

Loads the value(s) for this property from the given Properties instance, overwriting any current value. The current value of this property will be used as a default value in the event that this property does not exist in the given Properties instance.

Specified by:

loadFromProps in class AbstractProperty

Parameters:

props - Any Properties instance which contains value(s) for this property.

generateFormFieldImpl

protected FormField generateFormFieldImpl()

Description copied from class: AbstractProperty

Descendant classes must implement this method to generate a FormField associated with this property. The generateFormField() method in this class will call this abstract method to create the FormField, which will then be augmented with our fully qualified name, read-only state, help text, and extra attributes.

Specified by:

generateFormFieldImpl in class AbstractProperty

Returns:

A FormField associated with this property.

loadFromFormField

public void loadFromFormField(FormField field)

Description copied from class: AbstractProperty

Populates this Property's value(s) from the given form field, assuming the field is of the correct type.

Specified by:

loadFromFormField in class AbstractProperty

Parameters:

field - The FormField containing a value for this property.