Package org.openxava.view.meta

Class MetaView

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable
    public class MetaView
extends MetaElement
implements java.lang.Cloneable
    Author:
    Javier Paniza
    See Also:
    Serialized Form

    • Constructor Detail

      • MetaView

        public MetaView()

    • Method Detail

      • getMetaMembers

        public java.util.Collection getMetaMembers()
                                    throws XavaException
        Returns:
        Not null, of type MetaMember and read only
        Throws:
        XavaException

      • setName

        public void setName​(java.lang.String newName)
        If newName is null or empty is replaced by emptySection.

        If newName contains blanks (\n, \r, \t, \f) or whitespace are suppressed.

        Overrides:
        setName in class MetaElement
        Since:
        5.2.1

      • isAllMembers

        public boolean isAllMembers()

      • getMembersNames

        public java.util.Collection getMembersNames()
                                     throws XavaException
        Returns:
        Not nul, of type String and read only.
        Throws:
        XavaException

      • setMembersNames

        public void setMembersNames​(java.lang.String membersNames)
                     throws XavaException
        Parameters:
        membersNames - Names separated by commas or spaces.
        Throws:
        XavaException

      • setMembersNamesNotResetSections

        public void setMembersNamesNotResetSections​(java.lang.String membersNames)
                                     throws XavaException
        Parameters:
        membersNames - Names separated by commas or spaces.
        Throws:
        XavaException

      • setAllMembers

        public void setAllMembers​(boolean newAllMembers)

      • hasOnChangeAction

        public boolean hasOnChangeAction​(java.lang.String qualifiedPropertyName)

      • hasMetaSearchAction

        public boolean hasMetaSearchAction()

      • getMetaSearchAction

        public MetaSearchAction getMetaSearchAction()
        To search the objects of type that is represents by this view. Not for the references

      • setMetaSearchAction

        public void setMetaSearchAction​(MetaSearchAction metaSearchAction)

      • getMetaDescriptionsLists

        public java.util.Collection getMetaDescriptionsLists()
        Returns:
        of type MetaDescriptionsList

      • getMetaPropertyViewFor

        public MetaPropertyView getMetaPropertyViewFor​(java.lang.String qualifiedPropertyName)

      • getMetaReferenceViewFor

        public MetaReferenceView getMetaReferenceViewFor​(java.lang.String ref)

      • addSection

        public MetaView addSection​(java.lang.String name,
                           java.lang.String label,
                           java.lang.String members,
                           boolean alignedByColumns)
                    throws XavaException
        Returns:
        The added section
        Throws:
        XavaException

      • addMetaGroup

        public void addMetaGroup​(java.lang.String name,
                         java.lang.String label,
                         java.lang.String members,
                         boolean alignedByColumns)
                  throws XavaException
        Throws:
        XavaException

      • hasSections

        public boolean hasSections()

      • clearSections

        public void clearSections()

      • setMediatorClassName

        public void setMediatorClassName​(java.lang.String mediatorClassName)

      • getMetaCollectionView

        public MetaCollectionView getMetaCollectionView​(java.lang.String collectionName)
        Returns:
        Null if not found

      • isFrame

        public boolean isFrame()

      • setFrame

        public void setFrame​(boolean frame)

      • getId

        public java.lang.String getId()
        Description copied from class: MetaElement
        Unique id of element, normally used to search the label in the resources files.
        Specified by:
        getId in class MetaElement

      • getLabel

        protected java.lang.String getLabel​(java.util.Locale locale,
                                    java.lang.String id)
        Description copied from class: MetaElement
        Implementation of label obtaining.

        Overrides:
        getLabel in class MetaElement

      • getPropertiesNamesThrowOnChange

        public java.util.Collection getPropertiesNamesThrowOnChange()

      • getViewPropertiesNames

        public java.util.Collection getViewPropertiesNames()

      • getMetaViewProperties

        public java.util.Collection getMetaViewProperties()

      • clone

        protected java.lang.Object clone()
                          throws java.lang.CloneNotSupportedException
        Overrides:
        clone in class java.lang.Object
        Throws:
        java.lang.CloneNotSupportedException

      • getActionsNamesForProperty

        public java.util.Collection getActionsNamesForProperty​(MetaProperty p,
                                                       boolean editable)

      • getActionsNamesForReference

        public java.util.Collection getActionsNamesForReference​(MetaReference ref,
                                                        boolean editable)

      • getLabelFormatForProperty

        public java.lang.Integer getLabelFormatForProperty​(MetaProperty p)
        If not label format specified for the property returns null.

      • getLabelFormatForReference

        public java.lang.Integer getLabelFormatForReference​(MetaReference ref)
        If not label format specified for the reference returns null.

      • getLabelFormatFor

        public int getLabelFormatFor​(MetaMember m)
        If not label format specified for the member returns the defaultLabelFormat from XavaPreferences.
        Since:
        5.7

      • getEditorFor

        public java.lang.String getEditorFor​(MetaMember m)
        Returns:
        Empty string if no editor is defined for this property

      • isAlignedByColumns

        public boolean isAlignedByColumns()

      • setAlignedByColumns

        public void setAlignedByColumns​(boolean alignedByColumns)

      • containsViewProperty

        public boolean containsViewProperty​(java.lang.String name)

      • getNotAlwaysEnabledViewActionsNames

        public java.util.Collection getNotAlwaysEnabledViewActionsNames()

      • getExtendsView

        public java.lang.String getExtendsView()

      • setExtendsView

        public void setExtendsView​(java.lang.String extendsView)

      • getLabelStyleForProperty

        public java.lang.String getLabelStyleForProperty​(MetaProperty p)

      • getLabelStyleForReference

        public java.lang.String getLabelStyleForReference​(MetaReference ref)