logo BEITEL
  • このエントリーをはてなブックマークに追加

LoadContext

Java jp.carabiner.treeeditor.js.io.JSLoadContext

機能

ファイルの読み込みに関する情報を表現するオブジェクトです。

プロパティ

プロパティ名 機能
path
読み込み対象のパスです。

関数プロパティ

createModel()

機能
モデルを生成します。このモデルに読み込んだモデルを設定します。
引数
なし
戻り値
生成したモデルを返します。
FormatDocumentタイプのオブジェクトです。

info(String)

機能
ファイル読み込みに関する通知文字列を設定します。
引数
  • メッセージ
    通知したいメッセージ文字列を指定します。
戻り値
なし

warning(String)

機能
ファイル読み込みに関する警告文字列を設定します。
引数
  • メッセージ
    警告したいメッセージ文字列を指定します。
戻り値
なし

createIndeterminateProgress(String)

機能
進行率が明示できない処理であることを示し、進行率報告用オブジェクトを生成します。
引数
  • メッセージ
    処理中ダイアログに表示したいメッセージ文字列を指定します。
戻り値
進行率を管理するためのオブジェクトを返します。
Progressタイプのオブジェクトです。

createDeterminateProgress(String, int)

機能
進行率が明示できる処理であることを示し、進行率報告用オブジェクトを生成します。
引数
  • メッセージ
    処理中ダイアログに表示したいメッセージ文字列を指定します。
  • 完了までのタスク数
    完了までのタスク数を指定します。
    Progressオブジェクトの progress() を呼び出すと1タスク完了したとみなされます。
戻り値
進行率を管理するためのオブジェクトを返します。
Progressタイプのオブジェクトです。

SaveContext

Java jp.carabiner.treeeditor.js.io.JSSaveContext

機能

ファイルの保存に関する情報を表現するオブジェクトです。

プロパティ

プロパティ名 機能
path
保存対象のパスです。

関数プロパティ

getModel()

機能
現在開いているモデルを生成します。このモデルに保存したい内容が設定されます。
引数
なし
戻り値
保存したいモデルを返します。
FormatDocumentタイプのオブジェクトです。

info(String)

機能
ファイル読み込みに関する通知文字列を設定します。
引数
  • メッセージ
    通知したいメッセージ文字列を指定します。
戻り値
なし

warning(String)

機能
ファイル読み込みに関する警告文字列を設定します。
引数
  • メッセージ
    警告したいメッセージ文字列を指定します。
戻り値
なし

createIndeterminateProgress(String)

機能
進行率が明示できない処理であることを示し、進行率報告用オブジェクトを生成します。
引数
  • メッセージ
    処理中ダイアログに表示したいメッセージ文字列を指定します。
戻り値
進行率を管理するためのオブジェクトを返します。
Progressタイプのオブジェクトです。

createDeterminateProgress(String, int)

機能
進行率が明示できる処理であることを示し、進行率報告用オブジェクトを生成します。
引数
  • メッセージ
    処理中ダイアログに表示したいメッセージ文字列を指定します。
  • 完了までのタスク数
    完了までのタスク数を指定します。
    Progressオブジェクトの progress() を呼び出すと1タスク完了したとみなされます。
戻り値
進行率を管理するためのオブジェクトを返します。
Progressタイプのオブジェクトです。

ThumbnailManager

Java jp.carabiner.treeeditor.js.attachment.JSFileThumbnailFactoryManager

機能

添付ファイル・リンクファイルのサムネイル生成を管理するマネージャです。

プロパティ

プロパティ名 機能
childNodes
現在登録されているフォーマットのリストです。読み込みのみ可能です。
ThumbnailRendererListタイプのオブジェクトです。

関数プロパティ

appendChild(renderer)

機能
マネージャにレンダラを追加します。
引数
  • 新規レンダラ
    マネージャに追加するレンダラを指定します。
    ThumbnailRendererタイプのオブジェクトを指定することができます。
戻り値
追加されたレンダラが返されます。

createRenderer(ext)

機能
指定した拡張子を持つファイルに対してサムネイルレンダリングを行うようなレンダラを生成します。
生成されたレンダラオブジェクトは、appendChildされるまで有効になりません。
引数
  • 拡張子リスト
    生成するレンダラが処理すべき拡張子のリストを指定します。
    文字列のArrayである必要があります。大文字小文字は区別されません。
戻り値
形式を示すThumbnailRendererオブジェクトが返されます。

insertBefore(newRenderer, refRenderer)

機能
マネージャの指定位置にレンダラを追加します。
引数
  • 新規レンダラ
    マネージャに追加するレンダラを指定します。
    ThumbnailRendererタイプのオブジェクトを指定することができます。
  • 追加先
    追加先を示すレンダラを指定します。
戻り値
追加されたレンダラが返されます。

removeChild(renderer)

機能
マネージャから指定されたレンダラを削除します。
引数
  • 削除するレンダラ
    削除するレンダラを指定します。
戻り値
削除されたレンダラが返されます。

ThumbnailRendererList

Java jp.carabiner.treeeditor.js.attachment.JSRendererList

機能

サムネイルレンダラのリストを表現します。

プロパティ

プロパティ名 機能
length
リストの長さです。読み込みのみ可能です。

関数プロパティ

item(Number)

機能
ノードから要素を取得します。
Arrayと同様、[Number]によりアイテムを取得することも可能です。
引数
  • インデックス
    取得したい要素のインデックスを指定します。
戻り値
指定されたインデックスに対応する要素が返されます。
ThumbnailRendererタイプのオブジェクトです。

ThumbnailRenderer

Java jp.carabiner.treeeditor.js.attachment.JSCustomRenderer

機能

サムネイルのレンダリング機能を表現するオブジェクトです。

プロパティ

プロパティ名 機能
description
このレンダラの説明です。
renderCallback
このレンダラを使用してサムネイルをレンダリングする際に呼び出される関数です。
Functionタイプのオブジェクトです。第一引数にThumbnailRenderContext型のオブジェクトが設定されます。
parentNode
このフォーマットを管理するマネージャです。読み込みのみ可能です。
ThumbnailManagerタイプのオブジェクトです。

関数プロパティ

accept(String)

機能
このフォーマットが指定されたパスを受け入れるかどうかを判定します。
引数
  • パス
    テストしたいパス文字列を指定します。
戻り値
この形式が指定されたパスを受け入れる場合はtrue、それ以外はfalseを返します。

ThumbnailRenderContext

Java jp.carabiner.treeeditor.js.attachment.JSRenderContext

機能

サムネイルのレンダリングに関する情報を保持するオブジェクトです。

プロパティ

プロパティ名 機能
filename
レンダリング対象のファイル名です。
inputStream
レンダリング対象のデータです。
preferredSize
推奨レンダリングサイズです。必ずしもこのサイズに合わせて出力する必要はなく、レンダリング時の参考値として利用してください。

関数プロパティ

setBufferedImage(image)

機能
レンダリング結果を設定します。
サムネイルのレンダリング処理は、レンダリング完了後にこのメソッドを呼び出さなければなりません。
引数
  • 画像
    レンダリング結果の画像を指定します。
    このオブジェクトは、java.awt.image.BufferedImageである必要があります。
戻り値
なし

FormatManager

Java jp.carabiner.treeeditor.js.io.JSFormatManager

機能

ファイルの読み込み・書き込み形式を管理するマネージャです。

プロパティ

プロパティ名 機能
childNodes
現在登録されているフォーマットのリストです。読み込みのみ可能です。
FormatListタイプのオブジェクトです。

関数プロパティ

appendChild(format)

機能
マネージャに形式を追加します。
引数
  • 新規形式
    マネージャに追加する形式を指定します。
    Formatタイプのオブジェクトを指定することができます。
戻り値
追加された形式が返されます。

createFormat(ext)

機能
指定した拡張子に対して読み込み・書き込みを行うような形式を生成します。
生成された形式オブジェクトは、appendChildされるまで有効になりません。
引数
  • 拡張子リスト
    生成する形式が処理すべき拡張子のリストを指定します。
    文字列のArrayである必要があります。大文字小文字は区別されません。
戻り値
形式を示すFormatオブジェクトが返されます。

insertBefore(newFormat, refFormat)

機能
マネージャの指定位置に形式を追加します。
引数
  • 新規形式
    マネージャに追加する形式を指定します。
    Formatタイプのオブジェクトを指定することができます。
  • 追加先
    追加先を示す形式を指定します。
戻り値
追加された形式が返されます。

removeChild(format)

機能
マネージャから指定された形式を削除します。
引数
  • 削除する形式
    削除する形式を指定します。
戻り値
削除された形式が返されます。

FormatList

Java jp.carabiner.treeeditor.js.io.JSFormatList

機能

ファイル形式のリストを表現します。

プロパティ

プロパティ名 機能
length
リストの長さです。読み込みのみ可能です。

関数プロパティ

item(Number)

機能
ノードから要素を取得します。
Arrayと同様、[Number]によりアイテムを取得することも可能です。
引数
  • インデックス
    取得したい要素のインデックスを指定します。
戻り値
指定されたインデックスに対応する要素が返されます。
Formatタイプのオブジェクトです。

Format

Java jp.carabiner.treeeditor.js.io.JSLocalFileFormat

機能

ファイルの読み込み・書き込み形式を表現するオブジェクトです。

プロパティ

プロパティ名 機能
description
このフォーマットの説明です。
loadCallback
この形式によってファイルを読み込む場合に呼び出される関数です。
Functionタイプのオブジェクトです。第一引数にLoadContext型のオブジェクトが設定されます。
loadConfirmCallback
この形式によってファイルを読み込む前に呼び出される関数です。
Functionタイプのオブジェクトです。第一引数にパスを示すString型のオブジェクトが設定されます。また、読み込みを続行する場合にはtrueを、中断する場合はfalseを返す必要があります。
loadSupport
読み込みをサポートするかどうかを示すBoolean値です。
読み込みをサポートする場合はtrue、それ以外はfalseです。
saveCallback
この形式によってファイルを保存する場合に呼び出される関数です。
Functionタイプのオブジェクトです。第一引数にSaveContext型のオブジェクトが設定されます。
saveConfirmCallback
この形式によってファイルを保存する前に呼び出される関数です。
Functionタイプのオブジェクトです。第一引数にパスを示すString型のオブジェクトが設定されます。また、保存を続行する場合にはtrueを、中断する場合はfalseを返す必要があります。
saveSupport
保存をサポートするかどうかを示すBoolean値です。
保存をサポートする場合はtrue、それ以外はfalseです。
parentNode
このフォーマットを管理するマネージャです。読み込みのみ可能です。
FormatManagerタイプのオブジェクトです。

関数プロパティ

accept(String)

機能
このフォーマットが指定されたパスを受け入れるかどうかを判定します。
引数
  • パス
    テストしたいパス文字列を指定します。
戻り値
この形式が指定されたパスを受け入れる場合はtrue、それ以外はfalseを返します。

FormatDocument

Java jp.carabiner.treeeditor.js.IJSDocument

機能

読み込み、もしくは保存中のモデルです。

プロパティ

プロパティ名 機能
rootNode
ドキュメントのルートとなるノードです。
TreeNodeタイプのオブジェクトです。

関数プロパティ

createTreeNode(String)

機能
ツリーノードを新規作成します。
引数
  • ノード文字列
    ノードに設定する文字列を指定します。
戻り値
作成されたツリーノードが返されます。
TreeNodeタイプのオブジェクトです。