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;
026
027
028/**
029 * Translates to wiki syntax from a {@code SELECT} element.
030 */
031public abstract class SelectDecorator {
032
033    final protected PrintWriter out;
034    final protected XHtmlElementToWikiTranslator chain;
035
036    public SelectDecorator( final PrintWriter out, final XHtmlElementToWikiTranslator chain ) {
037        this.out = out;
038        this.chain = chain;
039    }
040
041    /**
042     * Translates the given XHTML element into wiki markup.
043     *
044     * @param e XHTML element being translated.
045     */
046    public void decorate( final Element e ) throws JDOMException {
047        final String name = MarkupHelper.nameSansNbf( e );
048        out.print( markupSelectOpen() );
049        if( name != null ) {
050            out.print( markupForSelectAttributeOpen( "name" ) );
051            out.print( name );
052            out.print( markupForSelectAttributeClose() );
053        }
054
055        out.print( markupForSelectAttributeOpen( "value" ) );
056        chain.translate( e );
057        out.print( markupForSelectAttributeClose() );
058        out.print( markupSelectClose() );
059    }
060
061    /**
062     * Opening wiki markup for a {@code SELECT}'s attribute.
063     *
064     * @param attr attribute's name.
065     * @return Opening wiki markup for a {@code SELECT} element.
066     */
067    protected abstract String markupForSelectAttributeOpen( String attr );
068
069    /**
070     * Closing wiki markup for a {@code SELECT}'s attribute.
071     *
072     * @return Closing wiki markup for a {@code SELECT} element.
073     */
074    protected abstract String markupForSelectAttributeClose();
075
076    /**
077     * Opening wiki markup for an {@code SELECT} element.
078     *
079     * @return Opening wiki markup for an {@code SELECT} element.
080     */
081    protected abstract String markupSelectOpen();
082
083    /**
084     * Closing wiki markup for an {@code SELECT} element.
085     *
086     * @return Closing wiki markup for an {@code SELECT} element.
087     */
088    protected abstract String markupSelectClose();
089
090}