Class StylesReferences

    • Constructor Detail

      • StylesReferences

        protected StylesReferences()
        Creates a Styles Reference property with no name and with a null value.
      • StylesReferences

        public StylesReferences​(Atom propertyAtom)
        Creates a Styles Reference property with the specified name with a null value.
        Parameters:
        propertyAtom - the property atom.
      • StylesReferences

        public StylesReferences​(Atom propertyAtom,
                                java.lang.String newValue)
                         throws PropValidateException
        Creates a Styles Reference property with the specified name and value.
        Parameters:
        propertyAtom - the property atom.
        newValue - the new string value for the property.
        Throws:
        PropValidateException - When the constraints are not met.
    • Method Detail

      • setPredefined

        public static void setPredefined​(java.util.Set<java.lang.String> predefined)
        Sets the predefined styles references for validation. This call is done by the Editor for the styles.
        Parameters:
        predefined - Predefined collection of names, without '*' prefix, '-' indicates a group delimiter.
      • isPredefinedNameValid

        public static boolean isPredefinedNameValid​(java.lang.String name)
        Checks if a Style name beginning with '*' contains valid characters.
      • getReferenceString

        public ReferenceString getReferenceString()
        Gets the reference string.
      • setPropValue

        public boolean setPropValue​(java.lang.String newValue)
                             throws PropValidateException
        Sets a new value for this property. If any listener is present and the value has changed compare to the last value, the listener is informed.
        Parameters:
        newValue - the new value.
        Returns:
        boolean true for value has changed, false for same value as current value.
        Throws:
        PropValidateException - When the constraints are not met.
      • validatePropType

        public void validatePropType​(java.lang.Object newValue)
                              throws PropTypeException
        Validates that the value to set is of ReferenceString 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<ReferenceString>
        Specified by:
        validatePropType in class GProp<ReferenceString>
        Parameters:
        newValue - The new value to set.
        Throws:
        PropTypeException - when the new value isn't of the correct class.
      • 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. Note that loss of precision in data if e.g. an Float property accepts a Double. However, the setPropertyValue throws IllegalArgumentException if the range in invalid, e.g. conversion of a Integer to a Byte, and the value is not -127 to 128.
        Specified by:
        getValueClasses in interface IGProp<ReferenceString>
        Specified by:
        getValueClasses in class GProp<ReferenceString>
        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.
      • 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<ReferenceString>
        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<ReferenceString>
        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.
      • onPropParentChanged

        protected void onPropParentChanged​(PropCnr oldParent,
                                           PropCnr newParent)
        Called when parent changed.
        Overrides:
        onPropParentChanged in class GProp<ReferenceString>
        Parameters:
        oldParent - The old parent (or null if none).
        newParent - The new parent (or null if none).
      • equalValues

        protected java.lang.Object equalValues​(GProp<?> compareTo,
                                               ReferenceString thisValue,
                                               ReferenceString compareValue,
                                               int how)
        Checks for property value equality. The object is of the correct type for the respective property type. The Atoms and other properties such as Private/Extends has already been checked for equality or correctness.
        Overrides:
        equalValues in class GProp<ReferenceString>
        Parameters:
        compareTo - The comparing-to property that contains the value.
        thisValue - This property value (for synchronization reasons).
        compareValue - Another property value.
        how - Flags EQC_* values for equal checking.
        Returns:
        The property not being equal, null for equal (both values null).
      • getReference

        public java.lang.String getReference()
        Gets the reference string.
        Returns:
        The reference string or null if not set.
      • onEventSelf

        public void onEventSelf​(GEvent event)
        Called when a property event is send to this property.

        A subclass can override this method to perform appropriate processing and is not required to call super.onEventSelf(e).

        Specified by:
        onEventSelf in interface IGProp<ReferenceString>
        Overrides:
        onEventSelf in class GProp<ReferenceString>
        Parameters:
        event - The property event.
      • onReferenceEvent

        protected void onReferenceEvent​(ResolveReferencesEvent event)
        Called to perform reference resolving. A property should override this method if it needs to perform reference resolving and validation.

        Subclasses override this method and only subclasses extending PropCnr needs to call super.onReferenceEvent(ResolveReferenceEvent event).

        Overrides:
        onReferenceEvent in class GProp<ReferenceString>
        Parameters:
        event - The resolve references event.
      • onProjectNameChanged

        protected void onProjectNameChanged​(ProjectNameEvent event)
        Called when a project name has been changed.
        Parameters:
        event - The project name event.
      • isPropValueTreeLockNeeded

        protected boolean isPropValueTreeLockNeeded()
        Checks if the tree needs to be locked when setting the property value.
        Overrides:
        isPropValueTreeLockNeeded in class GProp<ReferenceString>
        Returns:
        true for this class.
      • onPropValueSet

        protected void onPropValueSet​(java.lang.Object oldValue)
        Called when the property value is changed by the GProp class. This method is typically overridden by subclasses to clear cached values of a representation of this value.

        Note: this method is called during a synchronized state of the class instance!

        Overrides:
        onPropValueSet in class GProp<ReferenceString>
        Parameters:
        oldValue - The old value.
      • getAllStyles

        public Styles[] getAllStyles()
        Gets the Styles associates with the references. The array may contain null members in which case that reference is not resolved.
        Returns:
        The array returned is never null, i.e. Styles [0] if no references are present.
      • getReferences

        public int getReferences​(java.util.List<Reference> references)
        Gets the references of this property top others. This method is typically used in the Designer to search for circular references during verification.
        Specified by:
        getReferences in interface IGProp<ReferenceString>
        Overrides:
        getReferences in class GProp<ReferenceString>
        Parameters:
        references - The references array is filled in by this method.
        Returns:
        The count of references added.
      • resolveRuntimeReferences

        public void resolveRuntimeReferences​(IRuntimeResolver resolver)
        Called before transactions are prepared for sending. This method allows creation of e.g. runtime references such as Styles or Panel references that adds a virtual instance for the Client.

        This call is propagated in the entire client tree.

        Specified by:
        resolveRuntimeReferences in interface IGProp<ReferenceString>
        Overrides:
        resolveRuntimeReferences in class GProp<ReferenceString>
        Parameters:
        resolver - The reference resolver.
      • initializeValue

        public boolean initializeValue​(PropMgr propertyManager,
                                       ReadTransaction trans)
                                throws PropException
        Initializes the property value from a transaction.
        Specified by:
        initializeValue in class GProp<ReferenceString>
        Parameters:
        propertyManager - the property manager.
        trans - the transaction to initialize the property with.
        Returns:
        true if the value has changed, false otherwise.
        Throws:
        PropException
      • appendPropValue

        protected void appendPropValue​(PropMgr propertyManager,
                                       SendTransaction trans,
                                       java.lang.Object value)
        Appends the Styles References property value for the client.
        Specified by:
        appendPropValue in class GProp<ReferenceString>
        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.