com.adventnet.nms.util
Class CustomViewObject

java.lang.Object
  |
  +--com.adventnet.nms.util.FieldObject
        |
        +--com.adventnet.nms.util.FormObject
              |
              +--com.adventnet.nms.util.CustomViewObject

public class CustomViewObject

extends FormObject

This class serves as a container for the indivijual properties that are part of property form dealing with custom views . The custom class which customizes the property form will receive the properties in the form of CustomViewObjects. This class contains methods which helps the custom class to check the following information about the properties that it deals with.

1. The name of the property.

2. Whether the property is editable.

3. Possible values the property could take.

4. The current value for the property.

5. Whether that property should be listed for viewing.

6. The display name to be used for the property.

The custom class can only update the current value, display name and whether to view option, of the property and cannot change the editable attribute or the value list for the property.

Since:

WebNMS 2.1

See Also:

com.adventnet.nms.util.FormObject., com.adventnet.nms.util.FieldObject., com.adventnet.nms.util.DataFormCustomizer.

Constructor Summary

CustomViewObject(java.lang.String propName, java.util.Vector values, boolean canEdit, java.lang.Object selectedValue, boolean display, java.lang.String dispName)
Constructor which takes in all the required parameters.

Method Summary

java.lang.String	getDisplayName() This method is used to get the current displayName of the property.
boolean	isDisplayed() This method is used to check whether the property has been added to the display or not
void	setDisplay(boolean value) This method is used to specify whether the property should be added to the display or not
void	setDisplayName(java.lang.String dispName) This method is used to set the name to be used while displaying the the property.

Methods inherited from class com.adventnet.nms.util.FormObject

getCurrentValue, setCurrentValue

Methods inherited from class com.adventnet.nms.util.FieldObject

getPropertyName, getValuesList, isEditable, setEditable

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CustomViewObject

public CustomViewObject(java.lang.String propName,
                        java.util.Vector values,
                        boolean canEdit,
                        java.lang.Object selectedValue,
                        boolean display,
                        java.lang.String dispName)

Constructor which takes in all the required parameters.

Parameters:

values - specifes all possible values for the property.

canEdit - specifies whether the property is editable or not.

selectedValue - specifes the current value for the property.

Method Detail

setDisplay

public void setDisplay(boolean value)

This method is used to specify whether the property should be added to the display or not

Parameters:

value - Should be given true if the property is to be added to the display. Otherwise should be false.

isDisplayed

public boolean isDisplayed()

This method is used to check whether the property has been added to the display or not

Returns:

Returns true if the property had been added to the display. Otherwise returns false.

setDisplayName

public void setDisplayName(java.lang.String dispName)

This method is used to set the name to be used while displaying the the property.

Parameters:

dispName - specifies the name to be used as the display name for the property.

getDisplayName

public java.lang.String getDisplayName()

This method is used to get the current displayName of the property.

Returns:

Returns the current display name set for the property.