Package org.csstudio.opibuilder.properties

Class FontProperty

java.lang.Object

org.csstudio.opibuilder.properties.AbstractWidgetProperty<OPIFont>

org.csstudio.opibuilder.properties.FontProperty

public class FontProperty
extends AbstractWidgetProperty<OPIFont>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	XML_ATTRIBUTE_FONT_HEIGHT	XML attribute name fontName.
static final String	XML_ATTRIBUTE_FONT_NAME	XML attribute name fontName.
static final String	XML_ATTRIBUTE_FONT_PIXELS
static final String	XML_ATTRIBUTE_FONT_STYLE	XML attribute name fontName.
static final String	XML_ELEMENT_FONT	XML attribute name font.
static final String	XML_ELEMENT_FONTNAME	XML attribute name fontName.

Fields inherited from class org.csstudio.opibuilder.properties.AbstractWidgetProperty

category, defaultValue, description, executionMode, prop_id, propertyValue, visibleInPropSheet, widgetModel

Constructor Summary

Constructors

Constructor	Description
FontProperty(String prop_id, String description, WidgetPropertyCategory category, String defaultValue)	Font Property Constructor.
FontProperty(String prop_id, String description, WidgetPropertyCategory category, FontData defaultValue)	Font Property Constructor.

Method Summary

Modifier and Type	Method	Description
OPIFont	checkValue(Object value)	Check if the requestNewValue is convertible or legal.
boolean	configurableByRule()	Subclass should override this method if it is configurable by rule.
protected PropertyDescriptor	createPropertyDescriptor()	Create the IPropertyDescriptor
OPIFont	readValueFromXML(org.jdom2.Element propElement)	Read the property value from a XML element.
String	toStringInRuleScript(OPIFont opiFont)	Convert to the property value string in the script generated by rule.
void	writeToXML(org.jdom2.Element propElement)	Write the property value into a XML element.

Methods inherited from class org.csstudio.opibuilder.properties.AbstractWidgetProperty

addPropertyChangeListener, firePropertyChange, getAllPropertyChangeListeners, getCategory, getDefaultValue, getDescription, getExecutionMode, getPropertyDescriptor, getPropertyID, getPropertyValue, getRawPropertyValue, isDefaultValue, isSavable, isVisibleInPropSheet, onlyAcceptExpressionInRule, removeAllPropertyChangeListeners, removePropertyChangeListener, setCategory, setDefaultValue, setDescription, setExecutionMode, setPropertyValue, setPropertyValue, setPropertyValue_IgnoreOldValue, setSavable, setVisibleInPropSheet, setWidgetModel, toString

Methods inherited from class java.lang.Object

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

Field Details

XML_ELEMENT_FONT

public static final String XML_ELEMENT_FONT

XML attribute name font.

See Also:

• Constant Field Values

XML_ELEMENT_FONTNAME

public static final String XML_ELEMENT_FONTNAME

XML attribute name fontName.

See Also:

• Constant Field Values

XML_ATTRIBUTE_FONT_NAME

public static final String XML_ATTRIBUTE_FONT_NAME

XML attribute name fontName.

See Also:

• Constant Field Values

XML_ATTRIBUTE_FONT_HEIGHT

public static final String XML_ATTRIBUTE_FONT_HEIGHT

XML attribute name fontName.

See Also:

• Constant Field Values

XML_ATTRIBUTE_FONT_STYLE

public static final String XML_ATTRIBUTE_FONT_STYLE

XML attribute name fontName.

See Also:

• Constant Field Values

XML_ATTRIBUTE_FONT_PIXELS

public static final String XML_ATTRIBUTE_FONT_PIXELS

See Also:

• Constant Field Values

Constructor Details

FontProperty

public FontProperty(String prop_id,
 String description,
 WidgetPropertyCategory category,
 FontData defaultValue)

Font Property Constructor. The property value type is OPIFont.

Parameters:

prop_id - the property id which should be unique in a widget model.

description - the description of the property, which will be shown as the property name in property sheet.

category - the category of the widget.

defaultValue - the default value when the widget is first created.

FontProperty

public FontProperty(String prop_id,
 String description,
 WidgetPropertyCategory category,
 String defaultValue)

Font Property Constructor. The property value type is OPIFont.

Parameters:

prop_id - the property id which should be unique in a widget model.

description - the description of the property, which will be shown as the property name in property sheet.

category - the category of the widget.

defaultValue - the default value when the widget is first created. It must be a exist font macro name in font file.

Method Details

checkValue

public OPIFont checkValue(Object value)

Description copied from class: AbstractWidgetProperty

Check if the requestNewValue is convertible or legal.

Specified by:

checkValue in class AbstractWidgetProperty<OPIFont>

Parameters:

value - the value to be checked.

Returns:

The value after being checked. It might be coerced if the requestValue is illegal. return null if it is not convertible or illegal.

createPropertyDescriptor

protected PropertyDescriptor createPropertyDescriptor()

Description copied from class: AbstractWidgetProperty

Create the IPropertyDescriptor

Specified by:

createPropertyDescriptor in class AbstractWidgetProperty<OPIFont>

writeToXML

public void writeToXML(org.jdom2.Element propElement)

Description copied from class: AbstractWidgetProperty

Write the property value into a XML element.

Specified by:

writeToXML in class AbstractWidgetProperty<OPIFont>

readValueFromXML

public OPIFont readValueFromXML(org.jdom2.Element propElement)

Description copied from class: AbstractWidgetProperty

Read the property value from a XML element.

Specified by:

readValueFromXML in class AbstractWidgetProperty<OPIFont>

configurableByRule

public boolean configurableByRule()

Description copied from class: AbstractWidgetProperty

Subclass should override this method if it is configurable by rule. If this returns true, the method AbstractWidgetProperty.toStringInRuleScript(Object) should be properly overridden too.

Overrides:

configurableByRule in class AbstractWidgetProperty<OPIFont>

Returns:

true if this property is configurable by rule.

toStringInRuleScript

public String toStringInRuleScript(OPIFont opiFont)

Description copied from class: AbstractWidgetProperty

Convert to the property value string in the script generated by rule.

Overrides:

toStringInRuleScript in class AbstractWidgetProperty<OPIFont>