com.ngMAT.HTML
クラス HTMLTemplate

java.lang.Object
  |
  +--com.ngMAT.Common.ngmObject
        |
        +--com.ngMAT.HTML.HTMLComponent
              |
              +--com.ngMAT.HTML.HTMLTemplate
すべての実装インタフェース:
java.lang.Cloneable, ngmObjectFunction, java.io.Serializable

public class HTMLTemplate
extends HTMLComponent

This represents HTML template. このクラスはHTMLテンプレート機能をサポートします。
一般的な使い方は:

  1. HTMLTemplate template = new HTMLTemplate (filename); テンプレートを作成
  2. template.setInsertionTagValue (tagname, value); タグを値で置き換える
  3. String html = template.toHTML(); HTML文字列に変換
但し、通常、com.ngMAT.servlet.TemplateBasedServletのサブクラスの中で使用する場合、 new HTMLTemplate(...)の変わりに、getTemplate (filename)またはgetTemplate (template, req) を用い、toHTML()はflushの引数として渡す。
このクラスで使用する、テンプレート中のタグは
[[tagname]]....[[/tagname]]
または、
[[tagname/]]
の形式で表記する。
setInsertionTagValue (tagname, vlaue)は上記のタグ全体をvalueで置換する。結果として 前者の表記方法の場合、"...."の部分は、消去される。
タグ名はデフォルトでは"[["と"]]"で囲まれるが、プロパティにて、 "[["の代わりの指定
項目意味
Application.Tag.OpenChar
Application.Tag.CloseChar"]]"の代わりの指定
Application.Tag.EndChar"/"の代わりの指定
を指定することで、表記方法を変更することも可能である。

関連項目:
com.ngMAT.servlet.TemplateBasedServlet, CoolProperties, 直列化された形式

フィールドの概要
static java.lang.String HERE
          サーブレットが呼び出された際のURLに置換される特殊タグ。
static java.lang.String IFDEF_TAG_LEFT
          条件付き"#include"で使用。
static java.lang.String INCLUDE_TAG_NAME
          外部テンプレートの取り込みの指示をする特殊タグ。
static java.lang.String TBTABLE_TAG_NAME
          テーブルのテンプレートとして、このタグの直後に現れる<TABLE>タグのテーブルのロードを 指示する。
 
クラス com.ngMAT.HTML.HTMLComponent から継承したフィールド
BR, df, END_TAG_CHAR, NullParamValue, params, subelements, TAG_CLOSE_CHAR, TAG_OPEN_CHAR
 
インタフェース com.ngMAT.Common.ngmObjectFunction から継承したフィールド
C_BACKSLASH, C_BLOCK_CLOSE, C_BLOCK_OPEN, C_COMMA, C_CR, C_DOUBLE_QUATATION, C_EQUAL, C_LF, C_SINGLE_QUATATION, C_SPACE, C_TAB, S_BACKSLASH, S_BLOCK_CLOSE, S_BLOCK_OPEN, S_COMMA, S_CR, S_CRLF, S_DOUBLE_QUATATION, S_EQUAL, S_LF, S_SINGLE_QUATATION, S_SPACE, S_TAB
 
コンストラクタの概要
HTMLTemplate()
          何もしないコンストラクタ。
HTMLTemplate(java.lang.String filename)
           
HTMLTemplate(java.lang.String filename, java.util.Properties prop)
           
 
メソッドの概要
 java.lang.Object clone()
           
static HTMLTemplate createHTMLTemplateFromString(java.lang.String TemplateString)
          テンプレートを現す文字列から、HTMLTemplateオブジェクトを生成する。
static HTMLTemplate createHTMLTemplateFromString(java.lang.String TemplateString, java.util.Properties prop)
          テンプレートを現す文字列から、HTMLTemplateオブジェクトを生成する。
 java.util.Vector getBlocks()
          get the loaded HTML blocks.
 InsertionTag getInsertionTag(java.lang.String name)
          get an insertion tag object specified with parameter.
 java.util.Enumeration getInsertionTagNames()
          get all insertion tag names.
 java.util.Enumeration getInsertionTags()
          get all insertion tags.
 java.lang.String getTagName()
          returns tag name.
 java.util.Hashtable getTags()
          get insertion tags in the HTML template.
protected  void initialize(java.lang.String filename)
           
protected  void initialize(java.lang.String filename, java.util.Properties prop)
           
 void replaceHereTag(java.lang.String URLString)
           
 void setBlocks(java.util.Vector newblockes)
          各ブロック(InsertionTag, HTMLString)を順番に格納したVectorをセットする
 void setTags(java.util.Hashtable newtags)
          挿入タグを名前をキーとして格納したHashtableをセットする
 void setTagValue(java.lang.String tagname, boolean value)
           
 void setTagValue(java.lang.String tagname, double value)
           
 void setTagValue(java.lang.String tagname, float value)
           
 void setTagValue(java.lang.String tagname, HTMLComponent value)
          replace the specified tag value with the specified component.
 void setTagValue(java.lang.String tagname, int value)
           
 void setTagValue(java.lang.String tagname, long value)
           
 void setTagValue(java.lang.String tagname, java.lang.String value)
          replace the specified tag value with the specified string.
 java.lang.String toHTML()
          置換後のHTML文字列を返す
 
クラス com.ngMAT.HTML.HTMLComponent から継承したメソッド
getParameter, getParameters, getSubElements, getVersion, setParameter, setParameters, setSubElement, setSubElement, setSubElements, toString
 
クラス com.ngMAT.Common.ngmObject から継承したメソッド
debug, debug, equals_n, getLog, getProperties, getProperty, setLog, setNgmObject, setProperties
 
クラス java.lang.Object から継承したメソッド
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

フィールドの詳細

TBTABLE_TAG_NAME

public static final java.lang.String TBTABLE_TAG_NAME
テーブルのテンプレートとして、このタグの直後に現れる<TABLE>タグのテーブルのロードを 指示する。実際のタグ挿入ポイントは<TABLE>タグの位置になる。 This tag specifies for the very next <TABLE> tag to be loaded as a table template. The actual insertion tag point will be at the place of the next <TABLE> tag.

INCLUDE_TAG_NAME

public static final java.lang.String INCLUDE_TAG_NAME
外部テンプレートの取り込みの指示をする特殊タグ。[[#INCLUDE]]....[[/#INCLUDE]]で囲まれた 部分が外部ファイルの名称として使用される。 This string is a special tag "#include" which works like "#include" word in C language and load an external template file into the specified position.

IFDEF_TAG_LEFT

public static final java.lang.String IFDEF_TAG_LEFT
条件付き"#include"で使用。[[#INCLUDE]][[#IFDEF:]]....[[#INCLUDE]]の 形式で使用する。で指定されたプロパティが設定されていれば、"#include" が有効になる。終了タグは使用しない。 This tag is a switch to load an external template or not with "#include" tag pair. If the specified property is available it loads a file and when NO it ignores "#include" tag block. No close tags are required.

HERE

public static final java.lang.String HERE
サーブレットが呼び出された際のURLに置換される特殊タグ。アプリケーションサーブレット内で 処理される。 Application servlets are supposed to replace this special tag to the URL with which the servlet is called.
関連項目:
replaceHereTag (String URLString)
コンストラクタの詳細

HTMLTemplate

public HTMLTemplate()
何もしないコンストラクタ。Constructor without any process.

HTMLTemplate

public HTMLTemplate(java.lang.String filename)
             throws java.io.IOException
パラメータ:
filename - テンプレートファイル名

HTMLTemplate

public HTMLTemplate(java.lang.String filename,
                    java.util.Properties prop)
             throws java.io.IOException
パラメータ:
filename - テンプレートファイル名
prop - アプリ定義を含むプロパティオブジェクト
メソッドの詳細

initialize

protected void initialize(java.lang.String filename)
                   throws java.io.IOException

createHTMLTemplateFromString

public static HTMLTemplate createHTMLTemplateFromString(java.lang.String TemplateString)
                                                 throws java.io.IOException
テンプレートを現す文字列から、HTMLTemplateオブジェクトを生成する。
パラメータ:
TemplateString - テンプレート文字列

createHTMLTemplateFromString

public static HTMLTemplate createHTMLTemplateFromString(java.lang.String TemplateString,
                                                        java.util.Properties prop)
                                                 throws java.io.IOException
テンプレートを現す文字列から、HTMLTemplateオブジェクトを生成する。
パラメータ:
TemplateString - テンプレート文字列
prop - アプリ定義を含むプロパティオブジェクト

initialize

protected void initialize(java.lang.String filename,
                          java.util.Properties prop)
                   throws java.io.IOException

getBlocks

public java.util.Vector getBlocks()
get the loaded HTML blocks. An HTML template file is already divided into some blocks with insertion tags. HTMLブロックの取得。HTMLテンプレートは挿入タグを境に、いくつかのブロックに分割されている。

setBlocks

public void setBlocks(java.util.Vector newblockes)
各ブロック(InsertionTag, HTMLString)を順番に格納したVectorをセットする

getTags

public java.util.Hashtable getTags()
get insertion tags in the HTML template. HTMLテンプレート中のすべてのタグを取得。

setTags

public void setTags(java.util.Hashtable newtags)
挿入タグを名前をキーとして格納したHashtableをセットする

getInsertionTag

public InsertionTag getInsertionTag(java.lang.String name)
get an insertion tag object specified with parameter. パラメタで指定された名前の挿入タグを返す。
パラメータ:
name -  

getInsertionTags

public java.util.Enumeration getInsertionTags()
get all insertion tags. 全ての挿入タグを返す。
パラメータ:
name -  

getInsertionTagNames

public java.util.Enumeration getInsertionTagNames()
get all insertion tag names. 全ての挿入タグの名称一覧を返す。
パラメータ:
name -  

setTagValue

public void setTagValue(java.lang.String tagname,
                        java.lang.String value)
replace the specified tag value with the specified string. タグを指定された値で置換する。
パラメータ:
tagname -  
value -  

setTagValue

public void setTagValue(java.lang.String tagname,
                        long value)

setTagValue

public void setTagValue(java.lang.String tagname,
                        int value)

setTagValue

public void setTagValue(java.lang.String tagname,
                        boolean value)

setTagValue

public void setTagValue(java.lang.String tagname,
                        float value)

setTagValue

public void setTagValue(java.lang.String tagname,
                        double value)

setTagValue

public void setTagValue(java.lang.String tagname,
                        HTMLComponent value)
replace the specified tag value with the specified component. タグを指定されたコンポーネントで置換する。
パラメータ:
tagname -  
value -  

replaceHereTag

public void replaceHereTag(java.lang.String URLString)

getTagName

public java.lang.String getTagName()
クラス HTMLComponent の記述:
returns tag name. This must be implemented in sub classes.
オーバーライド:
クラス HTMLComponent 内の getTagName

toHTML

public java.lang.String toHTML()
置換後のHTML文字列を返す
オーバーライド:
クラス HTMLComponent 内の toHTML
戻り値:
HTML文字列

clone

public java.lang.Object clone()
オーバーライド:
クラス HTMLComponent 内の clone


バグや機能要求の報告
最新の情報
Copyright 2000 - ngMAT Corporation