Class IntroElement


  • public class IntroElement
    extends java.lang.Object
    Used to provide children of the computed gruops while constructing intro content. Clients provide instances of this class from IntroConfigurer to dynamically complete the intro content. Attribute and element names, as well as content model must match the intro schema.
    Since:
    3.2
    • Constructor Summary

      Constructors 
      Constructor Description
      IntroElement​(java.lang.String name)
      Creates a new intro element with the provided name.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addChild​(IntroElement child)
      Adds a child to this element.
      boolean equals​(java.lang.Object obj)  
      java.lang.String getAttribute​(java.lang.String name)
      Returns the value of the attribute with a given name.
      java.util.Enumeration<java.lang.String> getAttributes()
      Returns the names of all the attributes defined in this element.
      IntroElement[] getChildren()
      Returns the children of this element.
      java.lang.String getName()
      Returns the name of the element.
      java.lang.String getValue()
      Returns the value of the element.
      void setAttribute​(java.lang.String name, java.lang.String value)
      Sets the value of the named attribute.
      void setValue​(java.lang.String value)
      Sets the value of the element.
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • IntroElement

        public IntroElement​(java.lang.String name)
        Creates a new intro element with the provided name.
        Parameters:
        name - the name of the new intro element
    • Method Detail

      • setAttribute

        public void setAttribute​(java.lang.String name,
                                 java.lang.String value)
        Sets the value of the named attribute.
        Parameters:
        name - attribute name
        value - attribute value
      • getAttribute

        public java.lang.String getAttribute​(java.lang.String name)
        Returns the value of the attribute with a given name.
        Parameters:
        name - the attribute name
        Returns:
        value of the attribute with a given name or null if not set.
      • getAttributes

        public java.util.Enumeration<java.lang.String> getAttributes()
        Returns the names of all the attributes defined in this element.
        Returns:
        an enumeration of all the element names
      • getName

        public java.lang.String getName()
        Returns the name of the element.
        Returns:
        name of the element
      • getValue

        public java.lang.String getValue()
        Returns the value of the element.
        Returns:
        value of the element or null if not set.
      • setValue

        public void setValue​(java.lang.String value)
        Sets the value of the element.
        Parameters:
        value - the value of this element
      • addChild

        public void addChild​(IntroElement child)
        Adds a child to this element.
        Parameters:
        child - the new child of this element
      • getChildren

        public IntroElement[] getChildren()
        Returns the children of this element.
        Returns:
        an array of child elements or an empty array of there are no children.
      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object