uCosminexus Portal Framework　ポートレット開発ガイド

[目次][用語][索引][前へ][次へ]

jp.co.hitachi.soft.portal.api.csdc.lib.CsdcUtil

機能

クライアントサイドデータ通信機能のドラッグ用アイコンの画像を示すHTML文字列を取得します。

このAPIは，クライアントサイドデータ通信タグライブラリの<csdc:src>の<csdc:body>内で使用します。

メソッドの一覧

戻り値のデータ型 メソッド 説明
static String getDragIcon(HttpServletRequest request, String desc, String hclass, String src) クライアントサイドデータ通信機能のドラッグ用アイコンの画像を示すHTML文字列を取得します。
HTML内に格納するコードを出力する場合に使用します。ただし，alignパラメタは指定できません。
static String getDragIcon(HttpServletRequest request, String desc, int escape, String hclass, String hid, String src, String type) クライアントサイドデータ通信機能のドラッグ用アイコンの画像を示すHTML文字列を取得します。
JavaScript内に記載するためのコードを出力する場合に使用します。ただし，alignパラメタは指定できません。
static String getDragIcon(HttpServletRequest request, String desc, String hclass, String src, String align) クライアントサイドデータ通信機能のドラッグ用アイコンの画像を示すHTML文字列を取得します。
HTML内に格納するコードを出力する場合に使用します。alignパラメタを指定できます。
static String getDragIcon(HttpServletRequest request, String desc, int escape, String hclass, String hid, String src, String align, String type) クライアントサイドデータ通信機能のドラッグ用アイコンの画像を示すHTML文字列を取得します。
JavaScript内に記載するためのコードを出力する場合に使用します。alignパラメタを指定できます。

メソッドの説明

getDragIcon〔HTML用　alignパラメタなし〕

形式
public static String getDragIcon(HttpServletRequest request, 
                                 String desc, String hclass, 
                                 String src)

機能
指定したパラメタに従って，クライアントサイドデータ通信機能のドラッグ用アイコンの画像を示すHTML文字列を取得します。
HTML内に格納するコードを出力する場合に使用します。ただし，alignパラメタは指定できません。

パラメタ
request - JSP表示時のリクエストオブジェクト（null以外）
desc - <img>タグのalt属性に設定する文字列を指定してください。nullまたは空文字列を指定した場合，alt属性は設定されません。
hclass - <img>タグのclass属性に設定する文字列を指定してください。nullまたは空文字列を指定した場合，class属性は設定されません。
src - <img>タグのsrc属性に設定する文字列を指定してください。nullまたは空文字列を指定した場合，src属性は設定されません。

戻り値
ドラッグ用のアイコンを示すHTML文字列

例外
PortletException - 入力パラメタが不正な場合，またはこのAPIの使用個所が不正な場合

getDragIcon〔JavaScript用　align パラメタなし〕

形式
public static String getDragIcon(HttpServletRequest request, 
                                 String desc, int escape, 
                                 String hclass, String hid, 
                                 String src, String type)

機能
指定したパラメタに従って，クライアントサイドデータ通信機能のドラッグ用アイコンの画像を示すHTML文字列を取得します。
JavaScript内に記載するためのコードを出力する場合に使用します。ただし，alignパラメタは指定できません。

パラメタ
request - JSP表示時のリクエストオブジェクト（null以外）
desc - <img>タグのalt属性に設定する文字列を指定してください。nullまたは空文字列を指定した場合，alt属性は設定されません。
escape - JavaScript内で使用する場合に，区切り文字を変更するために指定します。
  • CSDC_DRAGICON_ESCAPE_TYPE_SINGLE_QUOTE（数値は0とする）：このメソッドが出力するHTMLをJavaScript上で文字列リテラルとして埋め込む場合で，文字列リテラルを「'」で囲むときに指定します。
  • CSDC_DRAGICON_ESCAPE_TYPE_DOUBLE_QUOTE（数値は1とする）：このメソッドが出力するHTMLをJavaScript上で文字列リテラルとして埋め込む場合で，文字列リテラルを「"」で囲むときに指定します。
  • CSDC_DRAGICON_ESCAPE_TYPE_NONE（数値は-1とする）：このメソッドが出力するHTMLを，HTML上に直接埋め込むときに指定します。
  • 上記以外の値の場合：CSDC_DRAGICON_ESCAPE_TYPE_NONEが指定されたものとして処理します。
hclass - <img>タグのclass属性に設定する文字列を指定してください。nullまたは空文字列を指定した場合，class属性は設定されません。
hid - <img>タグのid属性に設定する文字列を指定してください。nullまたは空文字列を指定した場合，id属性は設定されません。
src - <img>タグのsrc属性に設定する文字列を指定してください。nullまたは空文字列を指定した場合，src属性は設定されません。
type - ポートレットごとの組み込み型を指定します（例：people）。
このパラメタに指定した文字列は，src属性で指定するアイコンがどのような種別であるかを示すコメントになります。なお，このパラメタに指定した文字列は，クライアントサイドデータ通信クラスライブラリから参照されることがないため，不正な文字列が定義されていてもエラーにはなりません。

戻り値
ドラッグ用のアイコンを示すHTML文字列

例外
PortletException - 入力パラメタが不正な場合，またはこのAPIの使用個所が不正な場合

getDragIcon〔HTML用　align パラメタあり〕

形式
public static String getDragIcon(HttpServletRequest request, 
                                 String desc, String hclass, 
                                 String src, String align)

機能
指定したパラメタに従って，クライアントサイドデータ通信機能のドラッグ用アイコンの画像を示すHTML文字列を取得します。
HTML内に格納するコードを出力する場合に使用します。alignパラメタを指定できます。

パラメタ
request - JSP表示時のリクエストオブジェクト（null以外）
desc - <img>タグのalt属性に設定する文字列を指定してください。nullまたは空文字列を指定した場合，alt属性は設定されません。
hclass - <img>タグのclass属性に設定する文字列を指定してください。nullまたは空文字列を指定した場合，class属性は設定されません。
src - <img>タグのsrc属性に設定する文字列を指定してください。nullまたは空文字列を指定した場合，src属性は設定されません。
align - <img>タグのalign属性に設定する文字列を指定してください。nullまたは空文字列を指定した場合，src属性は設定されません。

戻り値
ドラッグ用のアイコンを示すHTML文字列

例外
PortletException - 入力パラメタが不正な場合，またはこのAPIの使用個所が不正な場合

getDragIcon〔JavaScript用　align パラメタあり〕

形式
public static String getDragIcon(HttpServletRequest request, 
                                 String desc, int escape, 
                                 String hclass, String hid, 
                                 String src, String align, 
                                 String type)

機能
指定したパラメタに従って，クライアントサイドデータ通信機能のドラッグ用アイコンの画像を示すHTML文字列を取得します。
JavaScript内に記載するためのコードを出力する場合に使用します。alignパラメタを指定できます。

パラメタ
request - JSP表示時のリクエストオブジェクト（null以外）
desc - <img>タグのalt属性に設定する文字列を指定してください。nullまたは空文字列を指定した場合，alt属性は設定されません。
escape - JavaScript内で使用する場合に，区切り文字を変更するために指定します。
  • CSDC_DRAGICON_ESCAPE_TYPE_SINGLE_QUOTE（数値は0とする）：このメソッドが出力するHTMLをJavaScript上で文字列リテラルとして埋め込む場合で，文字列リテラルを「'」で囲むときに指定します。
  • CSDC_DRAGICON_ESCAPE_TYPE_DOUBLE_QUOTE（数値は1とする）：このメソッドが出力するHTMLをJavaScript上で文字列リテラルとして埋め込む場合で，文字列リテラルを「"」で囲むときに指定します。
  • CSDC_DRAGICON_ESCAPE_TYPE_NONE（数値は-1とする）：このメソッドが出力するHTMLを，HTML上に直接埋め込むときに指定します。
  • 上記以外の値の場合：CSDC_DRAGICON_ESCAPE_TYPE_NONEが指定されたものとして処理します。
hclass - <img>タグのclass属性に設定する文字列を指定してください。nullまたは空文字列を指定した場合，class属性は設定されません。
hid - <img>タグのid属性に設定する文字列を指定してください。nullまたは空文字列を指定した場合，id属性は設定されません。
src - <img>タグのsrc属性に設定する文字列を指定してください。nullまたは空文字列を指定した場合，src属性は設定されません。
align - <img>タグのalign属性に設定する文字列を指定してください。nullまたは空文字列を指定した場合，src属性は設定されません。
type - ポートレットごとの組み込み型を指定します（例：people）。
このパラメタに指定した文字列は，src属性で指定するアイコンがどのような種別であるかを示すコメントになります。なお，このパラメタに指定した文字列は，クライアントサイドデータ通信クラスライブラリから参照されることがないため，不正な文字列が定義されていてもエラーにはなりません。

戻り値
ドラッグ用のアイコンを示すHTML文字列

例外
PortletException - 入力パラメタが不正な場合，またはこのAPIの使用個所が不正な場合

[目次][前へ][次へ]

[他社商品名称に関する表示]

All Rights Reserved. Copyright (C) 2009, 2013, Hitachi, Ltd.
All Rights Reserved. Copyright (C) 2009, 2013, Hitachi INS Software, Ltd.