Package org.csstudio.opibuilder.properties

Class FilePathProperty

java.lang.Object

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

org.csstudio.opibuilder.properties.FilePathProperty

Direct Known Subclasses:

FilePathPropertyWithFilter

public class FilePathProperty
extends AbstractWidgetProperty<String>

The property for file path, which is represented as a String.

Field Summary

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

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

Constructor Summary

Constructors

Constructor	Description
FilePathProperty(String prop_id, String description, WidgetPropertyCategory category, String defaultValue, String[] fileExtensions)	File Path Property Constructor.
FilePathProperty(String prop_id, String description, WidgetPropertyCategory category, String defaultValue, String[] fileExtensions, boolean buildAbsolutePath)	File Path Property Constructor.

Method Summary

Modifier and Type	Method	Description
String	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
String	getPropertyValue()
String	readValueFromXML(org.jdom2.Element propElement)	Read the property value from a XML element.
String	toStringInRuleScript(String propValue)	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, 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

Constructor Details

FilePathProperty

public FilePathProperty(String prop_id,
 String description,
 WidgetPropertyCategory category,
 String defaultValue,
 String[] fileExtensions)

File Path Property Constructor. The property value type is IPath. It will automatically build the absolute path if it is relative path.

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.

fileExtensions - the allowed file extensions in the file open dialog.

FilePathProperty

public FilePathProperty(String prop_id,
 String description,
 WidgetPropertyCategory category,
 String defaultValue,
 String[] fileExtensions,
 boolean buildAbsolutePath)

File Path Property Constructor. The property value type is IPath.

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.

fileExtensions - the allowed file extensions in the file open dialog.

buildAbsolutePath - true if it should automatically build the absolute path from widget model.

Method Details

checkValue

public String checkValue(Object value)

Description copied from class: AbstractWidgetProperty

Check if the requestNewValue is convertible or legal.

Specified by:

checkValue in class AbstractWidgetProperty<String>

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<String>

getPropertyValue

public String getPropertyValue()

Overrides:

getPropertyValue in class AbstractWidgetProperty<String>

readValueFromXML

public String readValueFromXML(org.jdom2.Element propElement)

Description copied from class: AbstractWidgetProperty

Read the property value from a XML element.

Specified by:

readValueFromXML in class AbstractWidgetProperty<String>

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<String>

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<String>

Returns:

true if this property is configurable by rule.

toStringInRuleScript

public String toStringInRuleScript(String propValue)

Description copied from class: AbstractWidgetProperty

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

Overrides:

toStringInRuleScript in class AbstractWidgetProperty<String>