Class EditorPropCnr

  • All Implemented Interfaces:
    EventListener, IGProp<GProp<?>[]>, IPropCnr, java.lang.Cloneable

    public class EditorPropCnr
    extends PropCnr
    Editor Property Container, i.e. data only for the Editor. This container is not created in Server or Client from XML (file).
    Author:
    Christopher Mindus
    • Constructor Detail

      • EditorPropCnr

        public EditorPropCnr()
        Creates an Editor Property Container without name with a null value.
      • EditorPropCnr

        public EditorPropCnr​(Atom propertyAtom)
        Creates an Editor Property Container with the specified name with a null value.
        Parameters:
        propertyAtom - the property atom.
      • EditorPropCnr

        public EditorPropCnr​(Atom propertyAtom,
                             GProp<?>[] properties)
                      throws PropException
        Creates an Editor Property Container with the specified name and properties.
        Parameters:
        propertyAtom - the property atom.
        properties - the property array value.
        Throws:
        PropException - as structural changes in containers on client is prohibited.
    • Method Detail

      • shouldCreateEditorProps

        public static boolean shouldCreateEditorProps​(java.lang.String elementName)
        Check if this is an EditorPropCnr that should be loaded or not.
        Returns:
        false if this is the property container for the Editor and it's not the Editor, true otherwise.
      • shouldCreateProps

        protected boolean shouldCreateProps​(org.w3c.dom.Element element)
        Only the Editor will load children elements.
        Overrides:
        shouldCreateProps in class PropCnr
        Parameters:
        element - The element in question.
        Returns:
        true to create properties out of it, false to ignore the element.
      • isPropVolatileOrEditorOnly

        protected boolean isPropVolatileOrEditorOnly()
        Checks if this property is volatile, i.e. not written to XML, or if it is for editor-only.
        Overrides:
        isPropVolatileOrEditorOnly in class GProp<GProp<?>[]>
        Returns:
        true, always.
      • equalsTree

        protected java.lang.Object equalsTree​(PropCnr pc2,
                                              int how)
        Checks for equality in the whole container structure.

        NOTE: This method should not be overridden except in extreme situations, e.g. for MememtoPropCnr.

        Overrides:
        equalsTree in class PropCnr
        Parameters:
        pc2 - The property value to compare with.
        how - Flags EQC_* values for equal checking.
        Returns:
        Both atom and value are equal on all levels.