    001/*
    002 * Copyright (c) 2009 The openGion Project.
    003 *
    004 * Licensed under the Apache License, Version 2.0 (the "License");
    005 * you may not use this file except in compliance with the License.
    006 * You may obtain a copy of the License at
    007 *
    008 *     http://www.apache.org/licenses/LICENSE-2.0
    009 *
    010 * Unless required by applicable law or agreed to in writing, software
    011 * distributed under the License is distributed on an "AS IS" BASIS,
    012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
    013 * either express or implied. See the License for the specific language
    014 * governing permissions and limitations under the License.
    015 */
    016package org.opengion.hayabusa.taglib;
    017
    018/**
    019 * プルダウンメニューやデータリストを作成する場合の共通インターフェースです。
    020 *
    021 * これは、BODY部の optionタグからの情報を、取得する為に、SelectTag と DatalistTag の
    022 * 共通インターフェースとして定義します。
    023 *
    024 * @og.rev 5.7.1.0 (2013/12/06) 新規追加
    025 * @version  4.0
    026 * @author       Kazuhiko Hasegawa
    027 * @since    JDK5.0,
    028 */
    029public interface OptionAncestorIF  {
    030
    031        /**
    032         * メニュー項目の選択項目を追加します。
    033         *
    034         * select タグのBODY要素の OptionTag よりアクセスされます。
    035         *
    036         * @param       opt      オプションタグ文字列
    037         */
    038        void addOption( final String opt ) ;
    039
    040        /**
    041         * 値を外部から取り出します。
    042         *
    043         * OptionTag で、value を取り出して、内部の値と同じ場合は、選択状態にします。
    044         *
    045         * @return      内部に設定された値
    046         */
    047        String getValue();
    048
    049        /**
    050         * 複数選択可能時に全選択を設定するかどうかを返します。
    051         *
    052         * これは、上位入れ子のタグの OptionTag で、multipleAll を取り出して、
    053         * true であれば、全選択に設定します。
    054         *
    055         * @return      全選択:true / 通常:false
    056         */
    057        boolean isMultipleAll();
    058
    059        /**
    060         * パラメーター変換({&#064;XXXX}の置き換えをしない状態のパラメーターをセットします。
    061         *
    062         * @param   param パラメーター
    063         */
    064        void setRawParam( final String param );
    065}