Class ValueProp

  • All Implemented Interfaces:
    EventListener, IGProp<Value>, java.lang.Cloneable

    public class ValueProp
    extends GProp<Value>
    The value property holds the VirtualSpace Value object.
    • Constructor Detail

      • ValueProp

        public ValueProp()
        Creates the value property without a name. The name must be set in all cases using the setPropertyAtom call.
      • ValueProp

        public ValueProp​(Atom propertyAtom)
        Creates the value property with the specified name. All system-reserved names for components begins with "$".
        Parameters:
        propertyAtom - the name of the component, unique within it's parent.
      • ValueProp

        public ValueProp​(Atom propertyAtom,
                         Value value)
                  throws PropException
        Creates the value property with the specified name. All system-reserved names for components begins with "$".
        Parameters:
        propertyAtom - the name of the component, unique within it's parent.
        value - the value.
        Throws:
        PropException - If property value cannot be set.
    • Method Detail

      • getValueType

        public Value.Type getValueType()
        Gets the value type.
        Returns:
        The value type, or null if Value instance is null or unassigned.
      • appendPropValue

        protected void appendPropValue​(PropMgr propertyManager,
                                       SendTransaction trans,
                                       java.lang.Object value)
        Appends the property value.

        This method throws InternalError as the Value is not supposed to be transferred using a Transaction if the remote party is not a JavaScript client.

        Specified by:
        appendPropValue in class GProp<Value>
        Parameters:
        propertyManager - the property manager instance.
        trans - transaction to append the properties to.
        value - the value to append to the transaction, a reference to the current property value.
      • initializeValue

        public boolean initializeValue​(PropMgr propertyManager,
                                       ReadTransaction trans)
        Initializes the property value from a transaction.

        This method throws InternalError as the Value is not supposed to be transferred using a Transaction if the remote party is not a JavaScript client.

        Specified by:
        initializeValue in class GProp<Value>
        Parameters:
        propertyManager - the property manager.
        trans - the transaction to initialize the property with.
        Returns:
        Only throws, no "return".
      • initializeProp

        protected void initializeProp​(org.w3c.dom.Element element)
                               throws PropException
        Called to initialize the property from an Element. The property should initialize itself from attributes and nodes with appropriate information.
        Overrides:
        initializeProp in class GProp<Value>
        Parameters:
        element - The Element.
        Throws:
        PropException - when the initialization fails.
      • initializeElement

        protected void initializeElement​(org.w3c.dom.Element element)
        Called when the XML file for the property tree is serialized from properties. The property should fill attributes and nodes with appropriate information.
        Overrides:
        initializeElement in class GProp<Value>
        Parameters:
        element - The Element to initialize.
      • getValueClasses

        public java.lang.Class<?>[] getValueClasses()
        Gets the list of possible native Java classes that can be used to set a value using setPropertyValue, in order of importance.
        Specified by:
        getValueClasses in interface IGProp<Value>
        Specified by:
        getValueClasses in class GProp<Value>
        Returns:
        The array of Java classes that can be accepted in the setPropertyValue method. The first type is the "native" or most preferred type. The array is at least one item in length and never null.
      • validatePropType

        public void validatePropType​(java.lang.Object newValue)
                              throws PropTypeException
        Validates that the value to set is of GColor instance.

        Note: When this method is called, synchronization is done at the property itself, so no synchronization on the tree should be done.

        Specified by:
        validatePropType in interface IGProp<Value>
        Specified by:
        validatePropType in class GProp<Value>
        Parameters:
        newValue - The new value to set.
        Throws:
        PropTypeException - when the new value isn't of the correct class.
      • getPropValue0

        protected java.lang.Object getPropValue0​(java.lang.Object value,
                                                 int index)
                                          throws java.lang.Exception
        Gets the property value in another class form than the "native" one. This method tries conversion of a "native" property value into another class type. This method is used when filling in a POJO variable (Plain Old Java Object Field) from a "native" property value.
        Specified by:
        getPropValue0 in class GProp<Value>
        Parameters:
        value - The property value.
        index - The index in the Class array returned by getValueClasses().
        Returns:
        The property value in the requested class, after conversion.
        Throws:
        java.lang.Exception - Other exceptions that could occur.
      • toNativeValue0

        protected java.lang.Object toNativeValue0​(java.lang.Object value,
                                                  int index)
                                           throws java.lang.Exception
        Tries conversion of possibly accepted properties values using the setPropertyValue method into the most preferred property value type. If the input value already is of the preferred type, the same object is returned.
        Specified by:
        toNativeValue0 in class GProp<Value>
        Parameters:
        value - The input value to convert to native value.
        index - The index in the array returned by getValueClasses(), or -1 if not found.
        Returns:
        The converted input value in the preferred property value object type.
        Throws:
        java.lang.Exception - For conversion exceptions.
      • paramValue

        protected java.lang.String paramValue​(java.lang.Object value)
        Formats the value as a string to add to paramString. The default is to do "value.toString()" if value is not null, otherwise "[null]" is returned.
        Overrides:
        paramValue in class GProp<Value>
      • onPropParentChanged

        protected void onPropParentChanged​(PropCnr oldParent,
                                           PropCnr newParent)
        If the value property is added in any component that is not a VS field, make it private.
        Overrides:
        onPropParentChanged in class GProp<Value>
        Parameters:
        oldParent - The old parent (or null if none).
        newParent - The new parent (or null if none).