001/*
002    Licensed to the Apache Software Foundation (ASF) under one
003    or more contributor license agreements.  See the NOTICE file
004    distributed with this work for additional information
005    regarding copyright ownership.  The ASF licenses this file
006    to you under the Apache License, Version 2.0 (the
007    "License"); you may not use this file except in compliance
008    with the License.  You may obtain a copy of the License at
009
010       http://www.apache.org/licenses/LICENSE-2.0
011
012    Unless required by applicable law or agreed to in writing,
013    software distributed under the License is distributed on an
014    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015    KIND, either express or implied.  See the License for the
016    specific language governing permissions and limitations
017    under the License.
018 */
019package org.apache.wiki.htmltowiki.syntax;
020
021import org.apache.wiki.htmltowiki.XHtmlElementToWikiTranslator;
022import org.jdom2.Element;
023import org.jdom2.JDOMException;
024
025import java.io.PrintWriter;
026import java.util.Deque;
027
028
029/**
030 * Translates to wiki syntax from a {@code LI} element.
031 */
032public abstract class LiDecorator {
033
034    final protected PrintWriter out;
035    final protected Deque< String > liStack;
036    final protected XHtmlElementToWikiTranslator chain;
037
038    protected LiDecorator( final PrintWriter out, final Deque< String > liStack, final XHtmlElementToWikiTranslator chain ) {
039        this.out = out;
040        this.liStack = liStack;
041        this.chain = chain;
042    }
043
044    /**
045     * Translates the given XHTML element into wiki markup.
046     *
047     * @param base the parent of the XHTML element being translated.
048     * @param e XHTML element being translated.
049     */
050    public void decorate( final Element base, final Element e ) throws JDOMException {
051        out.print( markupLi( liStack ) );
052        chain.translate( e );
053
054        // The following line assumes that the XHTML has been "pretty-printed"
055        // (newlines separate child elements from their parents).
056        final boolean lastListItem = base.indexOf( e ) == ( base.getContentSize() - 2 );
057        final boolean sublistItem = liStack.size() > 1;
058
059        // only print a newline if this <li> element is not the last item within a sublist.
060        if ( !sublistItem || !lastListItem ) {
061            out.println();
062        }
063    }
064
065    /**
066     * Wiki markup for a {@code LI} element.
067     *
068     * @return Wiki markup for a {@code LI} element.
069     */
070    protected abstract String markupLi( Deque< String > liStack );
071
072}