/*
 * Copyright (c) 2009 The openGion Project.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
 * either express or implied. See the License for the specific language
 * governing permissions and limitations under the License.
 */
package org.opengion.plugin.column;

import org.opengion.fukurou.util.StringUtil;
import org.opengion.fukurou.util.TagBuffer;
import org.opengion.hayabusa.common.HybsSystem;
import org.opengion.hayabusa.db.AbstractRenderer;
import org.opengion.hayabusa.db.CellRenderer;
import org.opengion.hayabusa.db.DBColumn;

/**
 * IFRAME ﾚﾝﾃﾞﾗは、iframe 内部に value で指定したﾌｧｲﾙを表示する場合に
 * 使用するｸﾗｽです。
 * iframeのｻｲｽﾞはﾚﾝﾃﾞﾗｰﾊﾟﾗﾒｰﾀに、設定したい属性を記述します。
 * 例えば、width='600px' height='450px' などです。
 * src属性はvalueを設定し、name属性はｶﾗﾑ名(複数行の場合は、行番号付きの名前)
 * iframe の親には、div要素と class="Renderer_IFRAME" を付与しておきます。
 *
 * <div class="Renderer_IFRAME">
 *     <iframe name="ｶﾗﾑ名" src="valueの値" ﾚﾝﾃﾞﾗｰﾊﾟﾗﾒｰﾀ ></iframe>
 * </div>
 *
 * ｶﾗﾑの表示に必要な属性は、DBColumn ｵﾌﾞｼﾞｪｸﾄ より取り出します。
 * このｸﾗｽは、DBColumn ｵﾌﾞｼﾞｪｸﾄ毎に1つ作成されます。
 *
 * @og.rev 7.4.2.0 (2021/04/30) 新規作成
 * @og.group ﾃﾞｰﾀ表示
 *
 * @version  7.4
 * @author   Kazuhiko Hasegawa
 * @since    JDK11.0,
 */
public class Renderer_IFRAME extends AbstractRenderer {
        /** このﾌﾟﾛｸﾞﾗﾑのVERSION文字列を設定します。 {@value} */
        private static final String VERSION = "8.5.3.0 (2023/09/08)" ;

        private static final String DIV_ST = "<div class=\"Renderer_IFRAME\">";
        private static final String DIV_ED = "</div>";

        private String  name;
        private String  param;

        /**
         * ﾃﾞﾌｫﾙﾄｺﾝｽﾄﾗｸﾀｰ。
         * このｺﾝｽﾄﾗｸﾀｰで、基本ｵﾌﾞｼﾞｪｸﾄを作成します。
         *
         */
        public Renderer_IFRAME() { super(); }           // これも、自動的に呼ばれるが、空のﾒｿｯﾄﾞを作成すると警告されるので、明示的にしておきます。

        /**
         * DBColumnｵﾌﾞｼﾞｪｸﾄを指定したprivateｺﾝｽﾄﾗｸﾀｰ。
         *
         * @og.rev 7.4.2.0 (2021/04/30) 新規作成
         * @og.rev 8.5.3.0 (2023/09/08) DynamicAttributes対応
         *
         * @param       clm     DBColumnｵﾌﾞｼﾞｪｸﾄ
         */
        private Renderer_IFRAME( final DBColumn clm ) {
                // 6.4.1.1 (2016/01/16) PMD refactoring. It is a good practice to call super() in a constructor
                super();

                name  = clm.getName();
//              param = StringUtil.nval( clm.getRendererParam(), null );        // 空文字列はあえてnullにする。
//              param = StringUtil.nvalAdd( clm.getRendererParam() ,
//                                                                      clm.getRendererAttributes().get( "optionAttributes" ) );
                // 8.5.3.0 (2023/09/08) optionAttributesの使い方が分からない為、元に戻す
                param = StringUtil.nval( clm.getRendererParam(), null );        // 空文字列はあえてnullにする。
        }

        /**
         * 各ｵﾌﾞｼﾞｪｸﾄから自分のｲﾝｽﾀﾝｽを返します。
         * 自分自身をｷｬｯｼｭするのか、新たに作成するのかは、各ｻﾌﾞｸﾗｽの実装に
         * まかされます。
         *
         * @param       clm     DBColumnｵﾌﾞｼﾞｪｸﾄ
         *
         * @return      CellEditorｵﾌﾞｼﾞｪｸﾄ
         * @og.rtnNotNull
         */
        public CellRenderer newInstance( final DBColumn clm ) {
                return new Renderer_IFRAME( clm );
        }

        /**
         * ﾃﾞｰﾀの表示用文字列を返します。
         *
         * @og.rev 7.4.2.0 (2021/04/30) 新規作成
         *
         * @param       value   入力値
         * @return      ﾃﾞｰﾀの表示用文字列
         * @og.rtnNotNull
         */
        @Override
        public String getValue( final String value ) {
                return makeIframe( name, value );
        }

        /**
         * ﾃﾞｰﾀの表示用文字列を返します。
         *
         * @og.rev 7.4.2.0 (2021/04/30) 新規作成
         *
         * @param       row             行番号
         * @param       value   入力値
         * @return      ﾃﾞｰﾀ表示用の文字列
         * @og.rtnNotNull
         */
        @Override
        public String getValue( final int row,final String value ) {
                final String newName = name + HybsSystem.JOINT_STRING + row;
                return makeIframe( newName, value );
        }

        /**
         * ﾃﾞｰﾀ出力用の文字列を作成します。
         * ﾌｧｲﾙ等に出力する形式を想定しますので、HTMLﾀｸﾞを含まない
         * ﾃﾞｰﾀを返します。
         * 基本は #getValue( String ) をそのまま返します。
         *
         * @og.rev 7.4.2.0 (2021/04/30) 新規作成
         *
         * @param       value   入力値
         * @return      ﾃﾞｰﾀ出力用の文字列
         * @og.rtnNotNull
         * @see         #getValue( String )
         */
        @Override
        public String getWriteValue( final String value ) {
                return value == null ? "" : value;
        }

        /**
         * ﾃﾞｰﾀの表示用文字列を返します。
         *
         * @og.rev 7.4.2.0 (2021/04/30) 新規作成
         *
         * @param       name    ｶﾗﾑ名
         * @param       value   入力値 表示するﾌｧｲﾙのｱﾄﾞﾚｽ
         * @return      ﾃﾞｰﾀ表示用の文字列
         * @og.rtnNotNull
         */
        private String makeIframe( final String name,final String value ) {
                return DIV_ST
                        +       new TagBuffer( "iframe" )
                                        .add( "name"    , name  )
                                        .add( "id"              , name  )
                                        .add( "src"             , value )
                                        .addOptions( param              )               // ﾀｸﾞの属性として追加。nullの場合は、何もしない。
                                        .addBody( value )                               // iframeが機能しない場合に表示される。
                                        .makeTag()
                        +       DIV_ED;
        }
}