|
HATS 7.5.1 Web API ReferencePublicly accessible methods not documented here are for IBM internal use only and may change in a future release of the product. |
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.ibm.hats.common.HCustomProperty
public class HCustomProperty
Class defining an individual user-customizable property for an object
implementing ICustomPropertySupplier.
ICustomPropertySupplier,
ICustomPropertyValidator| Field Summary | |
|---|---|
static String |
CLASS_NAME
|
static int |
TYPE_BOOLEAN
HCustomProperty boolean type |
static int |
TYPE_BUTTON
HCustomProperty button type |
static int |
TYPE_COLOR
HCustomProperty color type |
static int |
TYPE_ENUMERATION
HCustomProperty Enumeration type |
static int |
TYPE_EXCLUSIVE_GROUP
HCustomProperty exclusive group type |
static int |
TYPE_EXCLUSIVE_OPTION
HCustomProperty exclusive option type |
static int |
TYPE_FILE
HCustomProperty file type |
static int |
TYPE_FLOAT
HCustomProperty float type |
static int |
TYPE_FONT
HCustomProperty font type |
static int |
TYPE_GLOBAL_VARIABLE
not currently used |
static int |
TYPE_GROUP
HCustomProperty group type |
static int |
TYPE_IMAGE
HCustomProperty image selection type |
static int |
TYPE_INT
HCustomProperty int type |
static int |
TYPE_INT_GREATER_ZERO
HCustomProperty positive integer type |
static int |
TYPE_INT_NOT_NEGATIVE
HCustomProperty non-negative integer type |
static int |
TYPE_PASSWORD
HCustomProperty password type |
static int |
TYPE_PURE_LABEL
HCustomProperty pure label type |
static int |
TYPE_REVERSE_PARENT_BOOLEAN
HCustomProperty reverse parent boolean type |
static int |
TYPE_SEPARATOR
HCustomProperty separator type |
static int |
TYPE_SHARED_GLOBAL_VARIABLE
not currently used |
static int |
TYPE_STRING
HCustomProperty String type |
static int |
TYPE_STYLE
HCustomProperty CSS style override type |
static int |
TYPE_STYLE_CLASS
HCustomProperty CSS class mapping type |
| Constructor Summary | |
|---|---|
HCustomProperty(String name,
int type,
String label,
boolean isRequired,
String[] prefilledValues,
String[] prefilledCodes,
String defaultValue,
ICustomPropertyValidator validator,
String helpID)
Constructs an HCustomProperty |
|
| Method Summary | |
|---|---|
String[] |
getChildEnablementValues()
Gets the possible values of this property's parent for which this property will be enabled. |
String |
getDefaultValue()
Gets this property's default value |
String |
getHelpID()
Gets context help ID pointing to description for this property |
String |
getImageName()
Gets the name of the image which is displayed with this custom property. |
String |
getLabel()
Gets this property's GUI label |
String |
getName()
Gets this property's name |
String |
getParent()
Gets name of parent property for this custom property |
String[] |
getPrefilledCodes()
Gets codes mapped to displayed values for a TYPE_ENUMERATION HCustomProperty |
String[] |
getPrefilledValues()
Gets values to display in GUI for a TYPE_ENUMERATION or HCustomProperty.TYPE_STRING HCustomProperty |
int |
getType()
Gets this property's type |
ICustomPropertyValidator |
getValidator()
Gets this property's validator |
boolean |
isBold()
Sets whether this property should be displayed in bold for a TYPE_PURE_LABEL. |
boolean |
isIndentUnderParent()
|
boolean |
isRequired()
Gets whether or not this property requires a value entered |
static HCustomProperty |
new_Boolean(String name,
String label,
boolean defaultValue,
ICustomPropertyValidator validator,
String helpID)
Convenience method for constructing TYPE_BOOLEAN HCustomProperty |
static HCustomProperty |
new_Color(String name,
String label,
boolean isRequired,
String defaultValue,
ICustomPropertyValidator validator,
String helpID)
Convenience method for constructing TYPE_COLOR HCustomProperty |
static HCustomProperty |
new_Enumeration(String name,
String label,
boolean isRequired,
String[] prefilledValues,
String[] prefilledCodes,
String defaultValue,
ICustomPropertyValidator validator,
String helpID)
Convenience method for constructing TYPE_ENUMERATION HCustomProperty |
static HCustomProperty |
new_Exclusive_Group(String name,
String label,
boolean defaultValue,
ICustomPropertyValidator validator,
String helpID)
Convenience method for constructing TYPE_EXCLUSIVE_GROUP HCustomProperty |
static HCustomProperty |
new_Exclusive_Option(String name,
String label,
String defaultValue,
ICustomPropertyValidator validator,
String helpID)
Convenience method for constructing TYPE_EXCLUSIVE_OPTION HCustomProperty |
static HCustomProperty |
new_Float(String name,
String label,
boolean isRequired,
float defaultValue,
ICustomPropertyValidator validator,
String helpID)
Convenience method for constructing TYPE_FLOAT HCustomProperty |
static HCustomProperty |
new_Group(String name,
String label,
boolean defaultValue,
ICustomPropertyValidator validator,
String helpID)
Convenience method for constructing TYPE_GROUP HCustomProperty |
static HCustomProperty |
new_Image(String name,
String label,
ICustomPropertyValidator validator,
String helpID)
|
static HCustomProperty |
new_ImageLabel(String caption,
String imageName)
Convenience method for constructing TYPE_PURE_LABEL HCustomProperty with the specified image for display. |
static HCustomProperty |
new_Int(String name,
String label,
boolean isRequired,
int defaultValue,
ICustomPropertyValidator validator,
String helpID)
Convenience method for constructing TYPE_INT HCustomProperty |
static HCustomProperty |
new_IntGreaterZero(String name,
String label,
boolean isRequired,
int defaultValue,
ICustomPropertyValidator validator,
String helpID)
Convenience method for constructing TYPE_INT_GREATER_ZERO HCustomProperty |
static HCustomProperty |
new_IntNotNegative(String name,
String label,
boolean isRequired,
int defaultValue,
ICustomPropertyValidator validator,
String helpID)
Convenience method for constructing TYPE_INT_NOT_NEGATIVE HCustomProperty |
static HCustomProperty |
new_Label(String caption)
Convenience method for constructing TYPE_PURE_LABEL HCustomProperty |
static HCustomProperty |
new_Password(String name,
String label,
boolean isRequired,
String defaultValue,
ICustomPropertyValidator validator,
String helpID)
Convenience method for constructing TYPE_PASSWORD HCustomProperty |
static HCustomProperty |
new_ReverseParentBoolean(String name,
String label,
boolean defaultValue,
ICustomPropertyValidator validator,
String helpID)
Convenience method for constructing TYPE_REVERSE_PARENT_BOOLEAN HCustomProperty |
static HCustomProperty |
new_Separator()
Convenience method for constructing TYPE_SEPARATOR HCustomProperty |
static HCustomProperty |
new_Separator(String parentName)
Convenience method for constructing TYPE_SEPARATOR HCustomProperty and setting its parent to the specified property. |
static HCustomProperty |
new_String(String name,
String label,
boolean isRequired,
String[] prefilledValues,
String defaultValue,
ICustomPropertyValidator validator,
String helpID)
Convenience method for constructing TYPE_STRING HCustomProperty |
static HCustomProperty |
new_Style(String name,
String label,
boolean isRequired,
String defaultValue,
ICustomPropertyValidator validator,
String helpID)
Convenience method for constructing TYPE_STYLE HCustomProperty |
static HCustomProperty |
new_StyleClass(String name,
String label,
boolean isRequired,
String defaultValue,
ICustomPropertyValidator validator,
String helpID)
Convenience method for constructing TYPE_STYLE_CLASS HCustomProperty |
void |
setBold(boolean b)
Sets whether this property should be displayed in bold for a TYPE_PURE_LABEL. |
void |
setChildEnablementValues(String[] values)
Sets the possible values of this property's parent for which this property will be enabled. |
void |
setDefaultValue(String newDefaultValue)
Sets this property's default value |
void |
setHelpID(String newHelpID)
Sets context help ID pointing to description for this property |
void |
setImageName(String string)
Sets the name of the image which is displayed with this custom property. |
void |
setIndentUnderParent(boolean indentUnderParent)
|
void |
setIsRequired(boolean newIsRequired)
Sets whether or not this property requires a value entered |
void |
setLabel(String newLabel)
Sets this property's GUI label |
void |
setName(String newName)
Sets this property's name |
void |
setParent(String newParentName)
Sets parent property for this custom property. |
void |
setPrefilledCodes(String[] newPrefilledCodes)
Sets codes mapped to displayed values for a TYPE_ENUMERATION HCustomProperty |
void |
setPrefilledValues(String[] newPrefilledValues)
Sets values to display in GUI for a TYPE_ENUMERATION or TYPE_STRING HCustomProperty. |
void |
setType(int newType)
Sets this property's type |
void |
setValidator(ICustomPropertyValidator newValidator)
Sets this property's validator |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
public static final String CLASS_NAME
public static final int TYPE_STRING
String type
public static final int TYPE_INT
int type
public static final int TYPE_FLOAT
float type
public static final int TYPE_BOOLEAN
boolean type
public static final int TYPE_ENUMERATION
Enumeration type
public static final int TYPE_PASSWORD
public static final int TYPE_FILE
public static final int TYPE_COLOR
public static final int TYPE_INT_GREATER_ZERO
public static final int TYPE_INT_NOT_NEGATIVE
public static final int TYPE_SEPARATOR
public static final int TYPE_GROUP
public static final int TYPE_EXCLUSIVE_OPTION
public static final int TYPE_EXCLUSIVE_GROUP
public static final int TYPE_REVERSE_PARENT_BOOLEAN
public static final int TYPE_PURE_LABEL
public static final int TYPE_STYLE_CLASS
public static final int TYPE_STYLE
public static final int TYPE_GLOBAL_VARIABLE
public static final int TYPE_SHARED_GLOBAL_VARIABLE
public static final int TYPE_FONT
public static final int TYPE_BUTTON
public static final int TYPE_IMAGE
| Constructor Detail |
|---|
public HCustomProperty(String name,
int type,
String label,
boolean isRequired,
String[] prefilledValues,
String[] prefilledCodes,
String defaultValue,
ICustomPropertyValidator validator,
String helpID)
name - name of this custom propertytype - type of this custom property, ie HCustomProperty.TYPE_COLORlabel - label for this custom property, to be displayed in the GUIisRequired - whether or not this property requires a value enteredprefilledValues - array of values to display for an HCustomProperty.TYPE_ENUMERATION or HCustomProperty.TYPE_STRINGprefilledCodes - array of codes for an HCustomProperty.TYPE_ENUMERATIONdefaultValue - default value for this custom propertyvalidator - property validator for this custom propertyhelpID - context help ID pointing to infopop for field corresponding to this property in the GUI| Method Detail |
|---|
public String getName()
public void setName(String newName)
newName - name for this propertypublic int getType()
public void setType(int newType)
newType - type for this propertypublic String getLabel()
public void setLabel(String newLabel)
newLabel - GUI label for this property, or null for empty Stringpublic boolean isRequired()
public void setIsRequired(boolean newIsRequired)
newIsRequired - whether or not this property is requiredpublic String[] getPrefilledValues()
TYPE_ENUMERATION or HCustomProperty.TYPE_STRING HCustomProperty
public void setPrefilledValues(String[] newPrefilledValues)
TYPE_ENUMERATION or TYPE_STRING HCustomProperty.
If non-null in TYPE_STRING, these are displayed in an editable combo box.
If non-null in TYPE_ENUMERATION, these are displayed in a non-editable combo box.
newPrefilledValues - array of values for this property, or null if no prefilled values are to be definedpublic String[] getPrefilledCodes()
TYPE_ENUMERATION HCustomProperty
TYPE_ENUMERATIONpublic void setPrefilledCodes(String[] newPrefilledCodes)
TYPE_ENUMERATION HCustomProperty
newPrefilledCodes - array of codes for this property, null if not TYPE_ENUMERATIONpublic String getDefaultValue()
public void setDefaultValue(String newDefaultValue)
newDefaultValue - default value for this propertypublic ICustomPropertyValidator getValidator()
public void setValidator(ICustomPropertyValidator newValidator)
newValidator - validator for this property, or null if no validation is requiredpublic String getHelpID()
public void setHelpID(String newHelpID)
newHelpID - context help ID for this property, or null if none is available
public static HCustomProperty new_String(String name,
String label,
boolean isRequired,
String[] prefilledValues,
String defaultValue,
ICustomPropertyValidator validator,
String helpID)
TYPE_STRING HCustomProperty
HCustomProperty.HCustomProperty(String, int, String, boolean, String[], String[], String, ICustomPropertyValidator, String)
public static HCustomProperty new_Int(String name,
String label,
boolean isRequired,
int defaultValue,
ICustomPropertyValidator validator,
String helpID)
TYPE_INT HCustomProperty
HCustomProperty.HCustomProperty(String, int, String, boolean, String[], String[], String, ICustomPropertyValidator, String)
public static HCustomProperty new_IntGreaterZero(String name,
String label,
boolean isRequired,
int defaultValue,
ICustomPropertyValidator validator,
String helpID)
TYPE_INT_GREATER_ZERO HCustomProperty
HCustomProperty.HCustomProperty(String, int, String, boolean, String[], String[], String, ICustomPropertyValidator, String)
public static HCustomProperty new_IntNotNegative(String name,
String label,
boolean isRequired,
int defaultValue,
ICustomPropertyValidator validator,
String helpID)
TYPE_INT_NOT_NEGATIVE HCustomProperty
HCustomProperty.HCustomProperty(String, int, String, boolean, String[], String[], String, ICustomPropertyValidator, String)
public static HCustomProperty new_Float(String name,
String label,
boolean isRequired,
float defaultValue,
ICustomPropertyValidator validator,
String helpID)
TYPE_FLOAT HCustomProperty
HCustomProperty.HCustomProperty(String, int, String, boolean, String[], String[], String, ICustomPropertyValidator, String)
public static HCustomProperty new_Boolean(String name,
String label,
boolean defaultValue,
ICustomPropertyValidator validator,
String helpID)
TYPE_BOOLEAN HCustomProperty
HCustomProperty.HCustomProperty(String, int, String, boolean, String[], String[], String, ICustomPropertyValidator, String)
public static HCustomProperty new_ReverseParentBoolean(String name,
String label,
boolean defaultValue,
ICustomPropertyValidator validator,
String helpID)
TYPE_REVERSE_PARENT_BOOLEAN HCustomProperty
HCustomProperty.HCustomProperty(String, int, String, boolean, String[], String[], String, ICustomPropertyValidator, String)
public static HCustomProperty new_Enumeration(String name,
String label,
boolean isRequired,
String[] prefilledValues,
String[] prefilledCodes,
String defaultValue,
ICustomPropertyValidator validator,
String helpID)
TYPE_ENUMERATION HCustomProperty
HCustomProperty.HCustomProperty(String, int, String, boolean, String[], String[], String, ICustomPropertyValidator, String)
public static HCustomProperty new_Password(String name,
String label,
boolean isRequired,
String defaultValue,
ICustomPropertyValidator validator,
String helpID)
TYPE_PASSWORD HCustomProperty
HCustomProperty.HCustomProperty(String, int, String, boolean, String[], String[], String, ICustomPropertyValidator, String)
public static HCustomProperty new_Color(String name,
String label,
boolean isRequired,
String defaultValue,
ICustomPropertyValidator validator,
String helpID)
TYPE_COLOR HCustomProperty
HCustomProperty.HCustomProperty(String, int, String, boolean, String[], String[], String, ICustomPropertyValidator, String)public static HCustomProperty new_Separator()
TYPE_SEPARATOR HCustomProperty
HCustomProperty.HCustomProperty(String, int, String, boolean, String[], String[], String, ICustomPropertyValidator, String)public static HCustomProperty new_Separator(String parentName)
TYPE_SEPARATOR HCustomProperty and setting its parent to the specified property.
parentName - name of the parent propertyHCustomProperty.HCustomProperty(String, int, String, boolean, String[], String[], String, ICustomPropertyValidator, String)
public static HCustomProperty new_Exclusive_Option(String name,
String label,
String defaultValue,
ICustomPropertyValidator validator,
String helpID)
TYPE_EXCLUSIVE_OPTION HCustomProperty
HCustomProperty.HCustomProperty(String, int, String, boolean, String[], String[], String, ICustomPropertyValidator, String)
public static HCustomProperty new_Group(String name,
String label,
boolean defaultValue,
ICustomPropertyValidator validator,
String helpID)
TYPE_GROUP HCustomProperty
HCustomProperty.HCustomProperty(String, int, String, boolean, String[], String[], String, ICustomPropertyValidator, String)
public static HCustomProperty new_Exclusive_Group(String name,
String label,
boolean defaultValue,
ICustomPropertyValidator validator,
String helpID)
TYPE_EXCLUSIVE_GROUP HCustomProperty
HCustomProperty.HCustomProperty(String, int, String, boolean, String[], String[], String, ICustomPropertyValidator, String)
public static HCustomProperty new_Style(String name,
String label,
boolean isRequired,
String defaultValue,
ICustomPropertyValidator validator,
String helpID)
TYPE_STYLE HCustomProperty
HCustomProperty.HCustomProperty(String, int, String, boolean, String[], String[], String, ICustomPropertyValidator, String),
HCustomProperty.TYPE_STYLE
public static HCustomProperty new_StyleClass(String name,
String label,
boolean isRequired,
String defaultValue,
ICustomPropertyValidator validator,
String helpID)
TYPE_STYLE_CLASS HCustomProperty
HCustomProperty.HCustomProperty(String, int, String, boolean, String[], String[], String, ICustomPropertyValidator, String),
HCustomProperty.TYPE_STYLE_CLASS
public static HCustomProperty new_ImageLabel(String caption,
String imageName)
TYPE_PURE_LABEL HCustomProperty with the specified image for display.
caption - label contentimageName - image to displayHCustomProperty.HCustomProperty(String, int, String, boolean, String[], String[], String, ICustomPropertyValidator, String),
HCustomProperty.TYPE_PURE_LABELpublic static HCustomProperty new_Label(String caption)
TYPE_PURE_LABEL HCustomProperty
caption - label contentHCustomProperty.HCustomProperty(String, int, String, boolean, String[], String[], String, ICustomPropertyValidator, String),
HCustomProperty.TYPE_PURE_LABEL
public static HCustomProperty new_Image(String name,
String label,
ICustomPropertyValidator validator,
String helpID)
public String getParent()
public void setParent(String newParentName)
newParentName - new parent for this property, or null if property has no parentpublic String[] getChildEnablementValues()
public void setChildEnablementValues(String[] values)
values - values needed for enablementpublic String getImageName()
public void setImageName(String string)
string - public boolean isBold()
TYPE_PURE_LABEL.
public void setBold(boolean b)
TYPE_PURE_LABEL.
public boolean isIndentUnderParent()
public void setIndentUnderParent(boolean indentUnderParent)
indentUnderParent - The indentUnderParent to set.
|
HATS 7.5.1 (201005110649) | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||