Package org.apache.maven.doxia.module.xdoc

Class XdocSink

    • Field Detail

      • boxedFlag

        private boolean boxedFlag
        An indication on if we're inside a box (verbatim).

      • encoding

        private java.lang.String encoding

      • languageId

        private java.lang.String languageId

    • Constructor Detail

      • XdocSink

        protected XdocSink​(java.io.Writer writer)
        Constructor, initialize the Writer.
        Parameters:
        writer - not null writer to write the result. Should be an UTF-8 Writer. You could use newXmlWriter methods from WriterFactory.

      • XdocSink

        protected XdocSink​(java.io.Writer writer,
                   java.lang.String encoding)
        Constructor, initialize the Writer and tells which encoding is used.
        Parameters:
        writer - not null writer to write the result.
        encoding - the encoding used, that should be written to the generated HTML content if not null.
        Since:
        1.1

      • XdocSink

        protected XdocSink​(java.io.Writer writer,
                   java.lang.String encoding,
                   java.lang.String languageId)
        Constructor, initialize the Writer and tells which encoding and languageId are used.
        Parameters:
        writer - not null writer to write the result.
        encoding - the encoding used, that should be written to the generated HTML content if not null.
        languageId - language identifier for the root element as defined by IETF BCP 47, Tags for the Identification of Languages; in addition, the empty string may be specified.
        Since:
        1.1

    • Method Detail

      • head

        public void head​(SinkEventAttributes attributes)
        Starts the head element.

        This contains information about the current document, (eg its title) that is not considered document content. The head element is optional but if it exists, it has to be unique within a sequence of Sink events that produces one output document, and it has to come before the Sink.body(SinkEventAttributes) element.

        The canonical sequence of events for the head element is: 

           sink.head();

   sink.title();
   sink.text( "Title" );
   sink.title_();

   sink.author();
   sink.text( "Author" );
   sink.author_();

   sink.date();
   sink.text( "Date" );
   sink.date_();

   sink.head_();

        but none of the enclosed events is required. However, if they exist they have to occur in the order shown, and the title() and date() events have to be unique (author() events may occur any number of times).

        Supported attributes are:

        PROFILE, LANG.
        Specified by:
        head in interface Sink
        Overrides:
        head in class SinkAdapter
        Parameters:
        attributes - A set of SinkEventAttributes, may be null.
        See Also:
        XdocMarkup.DOCUMENT_TAG, XdocMarkup.PROPERTIES_TAG

      • title

        public void title()
        Starts the title element.
        Specified by:
        title in interface Sink
        Overrides:
        title in class SinkAdapter
        See Also:
        HTML.Tag.TITLE

      • title_

        public void title_()
        Ends the title element.
        Specified by:
        title_ in interface Sink
        Overrides:
        title_ in class SinkAdapter
        See Also:
        HTML.Tag.TITLE

      • onSectionTitle

        protected void onSectionTitle​(int depth,
                              SinkEventAttributes attributes)
        Starts a section title. Starts a section title.
        Overrides:
        onSectionTitle in class XhtmlBaseSink
        Parameters:
        depth - The level of the section title.
        attributes - some attributes. May be null.
        See Also:
        HTML.Tag.H4, HTML.Tag.H5, HTML.Tag.H6

      • onSectionTitle_

        protected void onSectionTitle_​(int depth)
        Ends a section title. Ends a section title.
        Overrides:
        onSectionTitle_ in class XhtmlBaseSink
        Parameters:
        depth - The level of the section title.
        See Also:
        HTML.Tag.H4, HTML.Tag.H5, HTML.Tag.H6

      • verbatim

        public void verbatim​(SinkEventAttributes attributes)
        The default class style for boxed is source. Starts a verbatim block, ie a block where whitespace has semantic relevance.

        Text in a verbatim block must only be wrapped at the linebreaks in the source, and spaces should not be collapsed. It should be displayed in a fixed-width font to retain the formatting but the overall size may be chosen by the implementation.

        Most Sink events may be emitted within a verbatim block, the only elements explicitly forbidden are font-changing events and figures. Also, verbatim blocks may not be nested.

        Supported attributes are the base attributes plus:

        DECORATION (value: "boxed"), ALIGN, WIDTH.
        Specified by:
        verbatim in interface Sink
        Overrides:
        verbatim in class XhtmlBaseSink
        Parameters:
        attributes - a SinkEventAttributes object.
        See Also:
        XdocMarkup.SOURCE_TAG, HTML.Tag.PRE

      • tableRows

        public void tableRows​(int[] justification,
                      boolean grid)
        The default align is center. The default class style is bodyTable. The default align is center. Starts an element that contains rows of table data.
        Specified by:
        tableRows in interface Sink
        Overrides:
        tableRows in class XhtmlBaseSink
        Parameters:
        justification - the default justification of columns. This can be overridden by individual table rows or table cells. If null a left alignment is assumed by default. If this array has less elements than there are columns in the table then the value of the last array element will be taken as default for the remaining table cells.
        grid - true to provide a grid, false otherwise.
        See Also:
        HTML.Tag.TABLE

      • tableRow

        public void tableRow()
        The default valign is top. The default class style is a or b depending the row id. Starts a row element which acts as a container for a row of table cells.
        Specified by:
        tableRow in interface Sink
        Overrides:
        tableRow in class XhtmlBaseSink
        See Also:
        HTML.Tag.TR

      • link

        public void link​(java.lang.String name,
                 java.lang.String target)
        Adds a link with an optional target.
        Parameters:
        name - the link name.
        target - the link target, may be null.

      • markup

        protected void markup​(java.lang.String text)
        Deprecated.
        use write(String)
        Write text to output, preserving white space.
        Parameters:
        text - The text to write.