All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.symantec.itools.vcafe.openapi.VisualProperty

Object
   |
   +----com.symantec.itools.vcafe.openapi.VisualProperty

public abstract class VisualProperty

extends Object

Version:

1.0

Author:

Symantec Internet Tools Division

Since:

VCafe 3.0

See Also:

getProperties, InvalidVisualPropertyException

DEFAULT_OBJECT_REFERENCED

Indicates an object reference type property currently references the default VisualObject.

NO_OBJECT_REFERENCED

Indicates an object reference type property currently references no object (ie is "null").

com.symantec.itools.vcafe.openapi.VisualProperty()

appendValueString(String)

Appends a new element with the given value to this property (for arrays).

checkValidity()

Checks that this VisualProperty corresponds to a valid property in its VisualObject.

equals(VisualProperty)

Determines if one VisualProperty is equivalent to another.

getEnum(int)

Gets the value of an enumeration element (for enumerations).

getEnumKey(int)

getExceptions()

Gets the exceptions that setting this property can throw.

getFirstChild()

Gets the first child property of this property (for folders).

getGetterName()

Gets the name of the method used to get the value of this property.

getInternalPropertyName()

Gets the (internal, unique) name of this property.

getJavaInitializationString()

This method is intended for use when generating Java code to set the value of the property.

getLevel()

Gets the nesting level of this property (for grouped properties).

getName()

Gets the (human readable) name of this property.

getNthValueString(int)

Gets the value of an array element (for arrays).

getNumEnum()

Gets the number of String values this property enumerates (for enumerations).

getNumValues()

Gets the number of array elements this property has (for arrays).

getPropertyEditorName()

Gets the class name of the eidtor used to view and edit this property.

getPropertyType()

Gets the class of this property's value.

getReferencedVisualObject()

Gets the VisualObject the value of this property refers to, or null.

getReferencedVisualObjectID()

Gets the id of the VisualObject the value of this property refers to.

getSetterName()

Gets the name of the method used to set the value of this property.

getSetterParameterType()

Gets the class name of the the setter method's parameter.

getSibling()

Gets the sibling property of this property (for grouped properties).

getValue()

Gets an Object representation this property's value.

getValueString()

Gets a String representation of this property's value.

getVisualObject()

Gets the VisualObject that owns this property.

isArray()

Determines whether this is an array type property.

isBound()

isConstrained()

isCopyable()

Determines whether this property can be copied.

isCustom()

isCustomEditor()

Determines whether editing the value of this property requires a custom editor.

isDefault()

Determines if this property is currently set to its default value.

isEditable()

Determines whether the value of this property is editable.

isEnumerated()

Determines whether this is an enumerated type property.

isFolder()

Determines whether this is a folder type property.

isInvisible()

Determines whether this property is displayed in the Property List.

isMapped()

isObjectReferenceProperty()

Determines whether this is an object reference type property.

isPaintable()

isUserGroup()

isValid()

Determines if this VisualProperty corresponds to a valid property in its VisualObject.

setArrayEmpty()

Sets the number of array elements a property has to zero (for arrays).

setInvisible(boolean)

Sets whether this property is displayed in the Property List.

setNthValueString(int, String)

Sets the value of an array element (for arrays).

setReferencedVisualObjectID(int)

Sets the value of this property to a reference to a VisualObject.

setValueString(String)

Set this property's value, given a String representation of the new value.

toString()

Gets a String that represents this object.

unloadPropertyObject()

If the custom property has a reference to a java object, it will be released.

public static final int DEFAULT_OBJECT_REFERENCED

Indicates an object reference type property currently references the default VisualObject.

See Also:

getReferencedVisualObjectID, NO_OBJECT_REFERENCED

public static final int NO_OBJECT_REFERENCED

Indicates an object reference type property currently references no object (ie is "null").

See Also:

getReferencedVisualObjectID, DEFAULT_OBJECT_REFERENCED

public VisualProperty()

public abstract void appendValueString(String pValue)

Appends a new element with the given value to this property (for arrays).

Parameters:

pValue - String representation of the new value.

See Also:

isArray

public void checkValidity() throws InvalidVisualPropertyException

Checks that this VisualProperty corresponds to a valid property in its VisualObject. Note that the implementation of all of VisualProperty's abstract methods first call checkValidity(). Any method could therefore throw an InvalidVisualPropertyException.

Throws: InvalidVisualPropertyException

when its VisualObject has been removed from its project, or its project has been closed, for example

See Also:

isValid

public abstract boolean equals(VisualProperty other)

Determines if one VisualProperty is equivalent to another.

Parameters:

other - the VisualProperty to compare with.

Returns:

true if the two VisualProperties refer to the same property in the same VisualObject, false otherwise.

public abstract java.lang.String getEnum(int index)

Gets the value of an enumeration element (for enumerations).

Parameters:

the - zero-based enumeration index.

Returns:

the element value.

See Also:

isEnumerated

public abstract int getEnumKey(int index)

public abstract java.lang.String getExceptions()

Gets the exceptions that setting this property can throw. The returned value is a comma-delimited String like: "java.lang.NullPointerException,java.lang.NumberFormatException".

Returns:

a String of exceptions.

public abstract com.symantec.itools.vcafe.openapi.VisualProperty getFirstChild()

Gets the first child property of this property (for folders).

Returns:

this property's first child.

See Also:

isFolder

public abstract java.lang.String getGetterName()

Gets the name of the method used to get the value of this property.

Returns:

the name of the method used to get the property value.

See Also:

getSetterName, getPropertyType

public abstract java.lang.String getInternalPropertyName()

Gets the (internal, unique) name of this property.

Returns:

the unique name for this property.

public abstract java.lang.String getJavaInitializationString()

This method is intended for use when generating Java code to set the value of the property. It returns a fragment of Java code that can be used to initialize a variable with the current property value. Example results are: "2", "new Color(127,127,34)", "Color.orange", etc.

Returns:

a fragment of Java code representing an initializer for the current value.

public abstract int getLevel()

Gets the nesting level of this property (for grouped properties).

Returns:

this property's nesting level.

public abstract java.lang.String getName()

Gets the (human readable) name of this property.

Returns:

the name of this property.

public abstract java.lang.String getNthValueString(int index)

Gets the value of an array element (for arrays).

Parameters:

index - the zero-based element index.

Returns:

the value as a String.

See Also:

isArray

public abstract int getNumEnum()

Gets the number of String values this property enumerates (for enumerations).

Returns:

the number of elements.

See Also:

isEnumerated

public abstract int getNumValues()

Gets the number of array elements this property has (for arrays).

Returns:

the size of the array.

See Also:

isArray

public abstract java.lang.String getPropertyEditorName()

Gets the class name of the eidtor used to view and edit this property.

Returns:

the editor's class name.

public abstract com.symantec.itools.vcafe.openapi.dtreflect.DTClass getPropertyType()

Gets the class of this property's value.

Returns:

the class of this property's value.

See Also:

getGetterName, getSetterName

public abstract com.symantec.itools.vcafe.openapi.VisualObject getReferencedVisualObject()

Gets the VisualObject the value of this property refers to, or null.

Returns:

the VisualObject the value of this property refers to, or null.

See Also:

getReferencedVisualObjectID

public abstract int getReferencedVisualObjectID()

Gets the id of the VisualObject the value of this property refers to.

Returns:

the object ID of the VisualObject this property refers to or DEFAULT_OBJECT_REFERENCED or NODEFAULT_OBJECT_REFERENCED.

See Also:

DEFAULT_OBJECT_REFERENCED, NO_OBJECT_REFERENCED, setReferencedVisualObjectID, getReferencedVisualObject, getObjectID

public abstract java.lang.String getSetterName()

Gets the name of the method used to set the value of this property.

Returns:

the name of the method used to set the value of this property.

See Also:

getSetterParameterType, getGetterName, getPropertyType

public abstract java.lang.String getSetterParameterType()

Gets the class name of the the setter method's parameter.

Returns:

the class name of the parameter in the setter method.

See Also:

getSetterParameterType, getPropertyType

public abstract com.symantec.itools.vcafe.openapi.VisualProperty getSibling()

Gets the sibling property of this property (for grouped properties).

Returns:

this property's sibling.

public abstract java.lang.Object getValue()

Gets an Object representation this property's value. For example, if this property represents a VisualObject's font, a java.awt.Font object is returned.

Returns:

this property's value as an Object.

public abstract java.lang.String getValueString()

Gets a String representation of this property's value.

Returns:

this property's value as a String.

public abstract com.symantec.itools.vcafe.openapi.VisualObject getVisualObject()

Gets the VisualObject that owns this property.

Returns:

this property's VisualObject.

public abstract boolean isArray()

Determines whether this is an array type property.

Returns:

true if so, false otherwise.

public abstract boolean isBound()

public abstract boolean isConstrained()

public abstract boolean isCopyable()

Determines whether this property can be copied.

Returns:

true if so, false otherwise.

public abstract boolean isCustom()

public abstract boolean isCustomEditor()

Determines whether editing the value of this property requires a custom editor.

Returns:

true if so, false otherwise.

public abstract boolean isDefault()

Determines if this property is currently set to its default value.

Returns:

true if so, false otherwise.

public abstract boolean isEditable()

Determines whether the value of this property is editable.

Returns:

true if the value is editable, false otherwise.

public abstract boolean isEnumerated()

Determines whether this is an enumerated type property.

Returns:

true if so, false otherwise.

public abstract boolean isFolder()

Determines whether this is a folder type property.

Returns:

true if so, false otherwise.

public abstract boolean isInvisible()

Determines whether this property is displayed in the Property List.

Returns:

true if not, false otherwise.

public abstract boolean isMapped()

public abstract boolean isObjectReferenceProperty()

Determines whether this is an object reference type property. If true the value of this property is a reference to a VisualObject.

Returns:

true if so, false otherwise.

See Also:

getReferencedVisualObjectID, setReferencedVisualObjectID

public abstract boolean isPaintable()

public abstract boolean isUserGroup()

public abstract boolean isValid()

Determines if this VisualProperty corresponds to a valid property in its VisualObject. A VisualProperty can become invalid if it's VisualObject is removed from its project, or its project is closed, and the corresponding VisualObjectListener message is ignored, for example.

Returns:

true if the this VisualProperty is still valid, false otherwise

See Also:

checkValidity

public abstract void setArrayEmpty()

Sets the number of array elements a property has to zero (for arrays).

See Also:

isArray

public abstract void setInvisible(boolean invisible)

Sets whether this property is displayed in the Property List.

Parameters:

invisible - true if this property should not be displayed in the Property List.

public abstract void setNthValueString(int index,
                                       String pValue)

Sets the value of an array element (for arrays).

Parameters:

index - the zero-based element index.

pValue - String representation of the new value.

See Also:

isArray

public abstract void setReferencedVisualObjectID(int refVisualObjectID)

Sets the value of this property to a reference to a VisualObject.

Parameters:

refVisualObjectID - the object i of the VisualObject this property refers to or DEFAULT_OBJECT_REFERENCED or NODEFAULT_OBJECT_REFERENCED.

See Also:

DEFAULT_OBJECT_REFERENCED, NO_OBJECT_REFERENCED, getReferencedVisualObjectID, getReferencedVisualObject, getObjectID

public abstract boolean setValueString(String pValue)

Set this property's value, given a String representation of the new value.

Parameters:

pValue - String representation of the new value.

Returns:

true if successfully set, false otherwise.

public java.lang.String toString()

Gets a String that represents this object.

Returns:

the String.

Overrides:

toString in class Object

public abstract void unloadPropertyObject()

If the custom property has a reference to a java object, it will be released.

All Packages  Class Hierarchy  This Package  Previous  Next  Index