public class ResourceFilePropertyDescriptor extends SBPropertyDescriptor
The Operator field should be of type String (representing a name/path usually to be looked up via the resource search path of the containing application).
The contents of the resource may be retrieved using Operator.getResourceContents(String)
, giving the value
of the String field as the argument, or you may retrieve (if available) a File
using Operator.getResourceFile(String)
ResourceFilePropertyDescriptor.restrictFileHints(String[])
to improve user experience selecting a resource in Studio, 7.6.2 a ResourceFilePropertyDescriptor.TypeHint
enumeration is provided to indicate to Studio the kind of selector to displaySBPropertyDescriptor
Modifier and Type | Class and Description |
---|---|
static class |
ResourceFilePropertyDescriptor.TypeHint |
SBPropertyDescriptor.SingleValueSetter
_expressionInputPort, NOT_AN_EXPRESSION
Constructor and Description |
---|
ResourceFilePropertyDescriptor(PropertyDescriptor pd,
Class<?> beanClass)
Copy a property descriptor.
|
ResourceFilePropertyDescriptor(String propertyName,
Class<?> beanClass)
Constructs a resource descriptor with standard read/write method names
|
ResourceFilePropertyDescriptor(String propertyName,
Class<?> beanClass,
String readMethodName,
String writeMethodName)
Construct a resource descriptor with non-standard read/write method names.
|
Modifier and Type | Method and Description |
---|---|
ResourceFilePropertyDescriptor.TypeHint |
getType() |
ResourceFilePropertyDescriptor |
restrictFileHints(String[] restrictions)
Sets restrictions on the Studio UI used to display a chooser to select a resource file.
|
ResourceFilePropertyDescriptor |
typeHint(ResourceFilePropertyDescriptor.TypeHint type) |
deprecated, description, displayName, getExpressionInputPort, getMaskDisplay, getMultiLine, getUIHints, isDeprecated, isExpression, isRequired, mask, multiline, optional, setDeprecated, setMaskStringDisplay, setMultiLine, setRequired, setUIHints
createPropertyEditor, equals, getPropertyEditorClass, getPropertyType, getReadMethod, getWriteMethod, hashCode, isBound, isConstrained, setBound, setConstrained, setPropertyEditorClass, setReadMethod, setWriteMethod
attributeNames, getDisplayName, getName, getShortDescription, getValue, isExpert, isHidden, isPreferred, setDisplayName, setExpert, setHidden, setName, setPreferred, setShortDescription, setValue, toString
public ResourceFilePropertyDescriptor(String propertyName, Class<?> beanClass) throws IntrospectionException
propertyName
- the name of the propertybeanClass
- the operator class containing the propertyIntrospectionException
- if introspection failsResourceFilePropertyDescriptor
public ResourceFilePropertyDescriptor(String propertyName, Class<?> beanClass, String readMethodName, String writeMethodName) throws IntrospectionException
propertyName
- the name of the propertybeanClass
- the operator class containing the propertyreadMethodName
- the name of the method used to read the propertywriteMethodName
- the name of the method used to write the propertyIntrospectionException
- if introspection failsResourceFilePropertyDescriptor
public ResourceFilePropertyDescriptor(PropertyDescriptor pd, Class<?> beanClass) throws IntrospectionException
pd
- a property descriptor to copy frombeanClass
- the operator class containing the propertyIntrospectionException
- if introspection failsResourceFilePropertyDescriptor
public ResourceFilePropertyDescriptor restrictFileHints(String[] restrictions)
Note that this is a relaxed UI restriction, and does not prevent any value from being typed by the user, nor does it restrict resources the operator can access.
Two kinds of name restrictions are available:
.xml
,
and Studio will restrict the chooser to files ending in the provided extension, case insensitively.restrictions
- see method description, must not be nullpublic ResourceFilePropertyDescriptor typeHint(ResourceFilePropertyDescriptor.TypeHint type)
type
- the new type hint for this descriptorResourceFilePropertyDescriptor.TypeHint
public ResourceFilePropertyDescriptor.TypeHint getType()
ResourceFilePropertyDescriptor.TypeHint