|
install4j API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.beans.FeatureDescriptor
java.beans.PropertyDescriptor
com.install4j.api.beaninfo.Install4JPropertyDescriptor
public class Install4JPropertyDescriptor
Property descriptor for use in instances of Install4JBeanInfo
.
For file and script properties, derived classes are available.
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.
Field Summary | |
---|---|
static java.lang.String |
ATTRIBUTE_CONTEXT
|
static java.lang.String |
ATTRIBUTE_PROPERTY_CATEGORY
|
static java.lang.String |
ATTRIBUTE_SORT_KEY
|
static java.lang.String |
CATEGORY_CONFIGURATION
Default category used by install4j. |
static java.lang.String |
CONTEXT_DATETIME
Special context for properties of type java.util.Date that tells the install4j GUI to offer a time editor besides the default date editor as well. |
static java.lang.String |
CONTEXT_LAUNCHER_ID
Special context for properties of type java.lang.String that tells the install4j GUI to treat the string value as the id of a launcher. |
static java.lang.String |
CONTEXT_MULTILINE
Special context for properties of type java.lang.String that tells the install4j GUI to allow the user to enter multi-line strings in a separate dialog. |
static java.lang.String |
CONTEXT_NON_SERVICE_LAUNCHER_ID
Same as CONTEXT_LAUNCHER_ID , but service launchers are not selectable. |
static java.lang.String |
CONTEXT_SERVICE_LAUNCHER_ID
Same as CONTEXT_LAUNCHER_ID , but only service launchers are selectable. |
Method Summary | |
---|---|
static Install4JPropertyDescriptor |
create(java.lang.String propertyName,
java.lang.Class beanClass,
java.lang.String displayName,
java.lang.String shortDescription)
Same as create(String, Class, String, String, String) with a context of null. |
static Install4JPropertyDescriptor |
create(java.lang.String propertyName,
java.lang.Class beanClass,
java.lang.String displayName,
java.lang.String shortDescription,
java.lang.String context)
Create a property descriptor that can be passed to Install4JBeanInfo.addPropertyDescriptor(Install4JPropertyDescriptor) . |
void |
setDisplayName(java.lang.String displayName)
|
void |
setPropertyCategory(java.lang.String propertyCategory)
Configures the property category. |
void |
setSortKey(java.lang.Integer sortKey)
Set an integer key by which properties are sorted. |
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_PROPERTY_CATEGORY
setPropertyCategory(String)
,
Constant Field Valuespublic static final java.lang.String CATEGORY_CONFIGURATION
public static final java.lang.String ATTRIBUTE_CONTEXT
create(String, Class, String, String, String)
,
Constant Field Valuespublic static final java.lang.String CONTEXT_LAUNCHER_ID
public static final java.lang.String CONTEXT_NON_SERVICE_LAUNCHER_ID
CONTEXT_LAUNCHER_ID
, but service launchers are not selectable.
public static final java.lang.String CONTEXT_SERVICE_LAUNCHER_ID
CONTEXT_LAUNCHER_ID
, but only service launchers are selectable.
public static final java.lang.String CONTEXT_MULTILINE
public static final java.lang.String CONTEXT_DATETIME
public static final java.lang.String ATTRIBUTE_SORT_KEY
setSortKey(Integer)
,
Constant Field ValuesMethod Detail |
---|
public static Install4JPropertyDescriptor create(java.lang.String propertyName, java.lang.Class beanClass, java.lang.String displayName, java.lang.String shortDescription)
create(String, Class, String, String, String)
with a context of null.
public static Install4JPropertyDescriptor create(java.lang.String propertyName, java.lang.Class beanClass, java.lang.String displayName, java.lang.String shortDescription, java.lang.String context)
Install4JBeanInfo.addPropertyDescriptor(Install4JPropertyDescriptor)
.
propertyName
- the name of the propertybeanClass
- the class of the bean that contains th property. Note:This is not the class of the property.displayName
- the display name of the propertyshortDescription
- a short description of the propertycontext
- the context of the property. The context allows to specify different editors for the same property types.
See the CONTEXT_* properties for the built-in contexts. This context is also used for enumerated properties
in the EnumerationMapper
. For properties of type String[], you can pass an item name as the context.
public void setPropertyCategory(java.lang.String propertyCategory)
You can collapse certain categories by default with the
Install4JBeanInfo.setCollapsedPropertyCategories(String[])
method.
propertyCategory
- the categorypublic void setDisplayName(java.lang.String displayName)
setDisplayName
in class java.beans.FeatureDescriptor
public void setSortKey(java.lang.Integer sortKey)
sortKey
- the sort keyInstall4JBeanInfo.addPropertyDescriptor(Install4JPropertyDescriptor)
|
install4j API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |