java.lang.Objectjava.beans.FeatureDescriptor
java.beans.PropertyDescriptor
com.install4j.api.beaninfo.Install4JPropertyDescriptor
com.install4j.api.beaninfo.ScriptPropertyDescriptor
public class ScriptPropertyDescriptor
Property descriptor for properties of type ScriptProperty
.
With this descriptor you define the return type and the parameters that are passed to the script by
Context.runScript(com.install4j.api.beans.ScriptProperty, com.install4j.api.beans.Bean, Object[])
at runtime.
Using this class is not strictly required. In principle, you could also set values for the ATTRIBUTE_* constants in the property descriptor of an unrelated property descriptor class.
ScriptParameter
Field Summary | |
---|---|
static java.lang.String |
ATTRIBUTE_CODE_GALLERY_TAGS
|
static java.lang.String |
ATTRIBUTE_RETURN_TYPE
|
static java.lang.String |
ATTRIBUTE_SCRIPT_PARAMETERS
|
Method Summary | |
---|---|
static ScriptPropertyDescriptor |
create(java.lang.String propertyName,
java.lang.Class beanClass,
java.lang.String displayName,
java.lang.String shortDescription,
java.lang.Class returnType,
ScriptParameter[] scriptParameters)
Create a file property descriptor as with Install4JPropertyDescriptor.create(String, Class, String, String)
and additional configuration specific to script properties. |
ScriptPropertyDescriptor |
setCodeGalleryTags(java.lang.String[] tags)
Sets the code gallery tags that are are used to build the code gallery for this script property. |
Methods inherited from class com.install4j.api.beaninfo.Install4JPropertyDescriptor |
---|
create, create, setContext, setDisplayName, setParentProperty, setPropertyCategory, setPropertyChangeListener, setSortKey, setVariableValueClass, setVisibilityDiscriminator |
Methods inherited from class java.beans.PropertyDescriptor |
---|
createPropertyEditor, equals, getPropertyEditorClass, getPropertyType, getReadMethod, getWriteMethod, hashCode, isBound, isConstrained, setBound, setConstrained, setPropertyEditorClass, setReadMethod, setWriteMethod |
Methods inherited from class java.beans.FeatureDescriptor |
---|
attributeNames, getDisplayName, getName, getShortDescription, getValue, isExpert, isHidden, isPreferred, setExpert, setHidden, setName, setPreferred, setShortDescription, setValue |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String ATTRIBUTE_RETURN_TYPE
create(String, Class, String, String, Class, ScriptParameter[])
,
Constant Field Valuespublic static final java.lang.String ATTRIBUTE_SCRIPT_PARAMETERS
create(String, Class, String, String, Class, ScriptParameter[])
,
Constant Field Valuespublic static final java.lang.String ATTRIBUTE_CODE_GALLERY_TAGS
setCodeGalleryTags(String[])
,
Constant Field ValuesMethod Detail |
---|
public static ScriptPropertyDescriptor create(java.lang.String propertyName, java.lang.Class beanClass, java.lang.String displayName, java.lang.String shortDescription, java.lang.Class returnType, ScriptParameter[] scriptParameters)
Install4JPropertyDescriptor.create(String, Class, String, String)
and additional configuration specific to script properties.
returnType
- the class or the return type. Classes for primitive types are written as void.class or int.class.scriptParameters
- the additional parameters for the script or null if no additional parameters are passed.
ScriptProperty
,
Context.runScript(com.install4j.api.beans.ScriptProperty, com.install4j.api.beans.Bean, Object[])
public ScriptPropertyDescriptor setCodeGalleryTags(java.lang.String[] tags)
tags
- the additional tags that should be included in the code gallery