Class A_CmsXmlContentValue

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected A_CmsXmlContentValue()
      Default constructor for a XML content type that initializes some internal values.
      protected A_CmsXmlContentValue​(java.lang.String name, java.lang.String minOccurs, java.lang.String maxOccurs)
      Initializes the schema type descriptor values for this type descriptor.
      protected A_CmsXmlContentValue​(I_CmsXmlDocument document, org.dom4j.Element element, java.util.Locale locale, I_CmsXmlSchemaType type)
      Initializes the required members for this XML content value.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void appendXmlSchema​(org.dom4j.Element root)
      Appends an element XML representation of this type to the given root node.
      int compareTo​(I_CmsXmlSchemaType obj)  
      boolean equals​(java.lang.Object obj)  
      org.dom4j.Element generateXml​(CmsObject cms, I_CmsXmlDocument document, org.dom4j.Element root, java.util.Locale locale)
      Appends an XML for a new, empty node of this schema type to the given root element.
      int getChoiceMaxOccurs()
      Returns the maximum occurrences of choice options for this type in the current schema.
      CmsXmlContentDefinition getContentDefinition()
      Returns the content definition this schema type belongs to.
      java.lang.String getDefault​(java.util.Locale locale)
      Returns the default value for a node of this type in the current schema.
      java.lang.String getDefault​(CmsObject cms)
      Returns the default value of this parameter.
      I_CmsXmlDocument getDocument()
      Returns the XML content instance this value belongs to.
      org.dom4j.Element getElement()
      Returns the original XML element of this XML content value.
      java.lang.String getId()
      Returns the form id of this parameter.
      int getIndex()
      Returns the node index of this XML content value in the source XML document, starting with 0, with special handling of elements in choice groups.
      java.lang.String getKey()
      Returns the localized key identificator of this parameter.
      java.util.Locale getLocale()
      Returns the locale of this XML content value was generated for.
      int getMaxIndex()
      Returns the total number of XML elements of this type that currently exist in the source document.
      int getMaxOccurs()
      Returns the maximum occurrences of this type.
      int getMinOccurs()
      Returns the minimum occurrences of this type.
      java.lang.String getName()
      Returns the name.
      java.lang.String getPath()
      Returns the path of this XML content value in the source document.
      java.lang.String getPlainText​(CmsObject cms)
      Returns the value of this XML content node as a plain text String.
      protected CmsRelationType getRelationType​(java.lang.String path)
      Returns the relation type for the given path.
      int getXmlIndex()
      Returns the node index of this XML content value in the source XML document, starting with 0, based on the XML ordering.
      boolean hasError()
      Returns true if this widgets value contains an error.
      int hashCode()  
      boolean isChoiceOption()
      Returns true if this type is an option inside of a choice sequence.
      boolean isChoiceType()
      Returns true if this type defines a choice sequence.
      boolean isSearchable()
      The default implementation always returns true.
      boolean isSimpleType()
      Returns true if this is a simple type, or false if this type is a nested schema.
      void moveDown()
      Moves this XML content value one position down in the source document, if possible.
      void moveUp()
      Moves this XML content value one position up in the source document, if possible.
      protected void moveValue​(int step)
      Moves this XML content element up or down in the XML document.
      protected java.lang.String readSchemaDefinition​(java.lang.String schemaUri)
      Convenience method to loads the XML schema definition for this value type from an external file.
      void setContentDefinition​(CmsXmlContentDefinition contentDefinition)
      Sets the content definition this schema type belongs to.
      void setDefault​(java.lang.String defaultValue)
      Sets the default value for a node of this type.
      void setKeyPrefix​(java.lang.String prefix)
      Sets an optional localized key prefix identificator of this parameter.
      java.lang.String toString()  
      boolean validateValue​(java.lang.String value)
      Checks if a given value is valid according to the validation rule (regular expression) used for validation of this schema type in the XML schema.
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait