Class MarkupFragment

  • All Implemented Interfaces:
    java.lang.Iterable<MarkupElement>, IMarkupFragment

    public class MarkupFragment
    extends AbstractMarkupFragment
    Represents a portion of a markup file, but always spans a complete tag. E.g.
     open-body-close: <span>body</span>
     open-close:      <span/>
     open-no-close:   <input ...>body
     
    Author:
    Juergen Donnerstag
    See Also:
    Markup, MarkupElement
    • Constructor Detail

      • MarkupFragment

        public MarkupFragment​(IMarkupFragment markup,
                              int startIndex)
        Construct.
        Parameters:
        markup - The parent markup. May not be null.
        startIndex - The start index of the child markup
        Throws:
        java.lang.IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size())
    • Method Detail

      • get

        public final MarkupElement get​(int index)
        Description copied from interface: IMarkupFragment
        Get the MarkupElement at the index provided.
        Parameters:
        index - Index into markup list
        Returns:
        Markup element
      • find

        public final IMarkupFragment find​(java.lang.String id)
        Description copied from interface: IMarkupFragment
        Finds a markup fragment that spans a tag
        Returns:
        the markup fragment that spans the complete found tag
      • getMarkupResourceStream

        public final MarkupResourceStream getMarkupResourceStream()
        Description copied from interface: IMarkupFragment
        Get the underlying markup resource stream, which might contain more than just the markup portion represented by the IMarkupFragment.
        Returns:
        The underlying markup resource stream
      • size

        public final int size()
        Description copied from interface: IMarkupFragment
        The number of markup elements.
        Returns:
        Number of markup elements
      • getRootMarkup

        public final Markup getRootMarkup()
        Returns:
        The Markup representing the underlying markup file with all its content
      • toString

        public java.lang.String toString​(boolean markupOnly)
        Parameters:
        markupOnly - True if only the markup shall be returned
        Returns:
        markup string