public class UserPropertyDefnHandle extends ElementDetailHandle
UserPropertyDefn
elementHandle
Constructor and Description |
---|
UserPropertyDefnHandle(DesignElementHandle element,
java.lang.String propName)
Constructs a handle for the user-defined property with the given element
handle and the name of the user-defined property.
|
UserPropertyDefnHandle(DesignElementHandle element,
UserPropertyDefn prop)
Constructs a handle for the user-defined property with the given element
handle and the user-defined property.
|
Modifier and Type | Method and Description |
---|---|
UserPropertyDefn |
getCopy()
Returns the copy of the property definition for this user-defined
property.
|
UserPropertyDefn |
getDefn()
Gets the user-defined property of this handle.
|
java.lang.String |
getDisplayName()
Returns the display name of the user-defined property.
|
java.lang.String |
getName()
Returns the name of the user-defined property.
|
int |
getType()
Returns the type of the user-defined property.
|
void |
setUserPropertyDefn(UserPropertyDefn prop)
Sets the definition for the user-defined property.
|
getDesign, getElement, getElementHandle, getModule
public UserPropertyDefnHandle(DesignElementHandle element, UserPropertyDefn prop)
element
- a handle to a report elementprop
- The definition of the user-defined property.public UserPropertyDefnHandle(DesignElementHandle element, java.lang.String propName)
element
- a handle to a report elementpropName
- The name of the user-defined property.public java.lang.String getName()
public int getType()
PropertyType
public java.lang.String getDisplayName()
public void setUserPropertyDefn(UserPropertyDefn prop) throws UserPropertyException, PropertyValueException
prop
- the new definition of the user-defined propertyUserPropertyException
- if the property is not found, is not a user property, or is
not defined on this element, or the user property definition
is inconsistent.PropertyValueException
- if the type changes, the value becomes invalid.public UserPropertyDefn getCopy()
public UserPropertyDefn getDefn()
Copyright © 2008 Actuate Corp. All rights reserved.