jp.carabiner.treeeditor.js
クラス JSDocument

java.lang.Object
  上位を拡張 jp.carabiner.treeeditor.js.JSDocument
すべての実装されたインタフェース:
jp.carabiner.rhino.ScriptableObjectFactory, IJSDocument, ToplevelObject

public class JSDocument
extends Object
implements ToplevelObject, IJSDocument, jp.carabiner.rhino.ScriptableObjectFactory

ドキュメントを表現するクラスです。


コンストラクタの概要
JSDocument(JSRunner jsRunner, org.mozilla.javascript.Scriptable scope, TreeEditorFrame frame)
          構築します。
 
メソッドの概要
 void addEventListener(String name, Object f)
          イベントリスナを追加します。
 Object create(org.mozilla.javascript.Scriptable scope)
           
 JSTreeNode createTreeNode(String text)
          ツリーノードを生成します。
 void dispose()
          破棄します。
 JSColumnHeader[] getColumnHeaders()
          カラムヘッダのリストを取得します。
 jp.carabiner.treeeditor.TreeEditorContext getContext()
          コンテキストを取得します。
 jp.carabiner.treeeditor.config.DocumentStyle getDefaultDocumentStyle()
          ドキュメントスタイルのデフォルトを取得します。
 JSTreeNode getDefaultStyle()
          デフォルトスタイルを取得します。
 jp.carabiner.treeeditor.FileManager getFileManager()
          ファイルマネージャを取得します。
 String getFilename()
          ファイル名を取得します。
 String getFilepath()
          ファイルパスを取得します。
 String getHandleStyleClassname()
          ハンドルスタイルのクラス名を取得します。
 jp.carabiner.treeeditor.config.DocumentStyle getInternalDocumentStyle()
          内部管理用のDocumentStyleを取得します。
 int getNodeContentWidth()
          コンテンツ幅を取得します。
 JSNodeStyles getNodeStyles()
          ノードスタイルを取得します。
 Object getOnclose()
          閉じるイベント用のハンドラを取得します。
 Object getOnnodechange()
          ノード変更イベント用のハンドラを取得します。
 Object getOnopen()
          開くイベント用のハンドラを取得します。
 Object getOnpropchange()
          プロパティ変更イベント用のハンドラを取得します。
 jp.carabiner.treeeditor.op.CompositeOp getOwnerOp()
          操作オーナーを取得します。
 jp.carabiner.treeeditor.ITreeNodePanel getPanelByNode(TreeNode node)
          パネルを取得します。
 JSTreeNode getRootNode()
          ルートノードを取得します。
 org.mozilla.javascript.Scriptable getScope()
          スコープを取得します。
 JSHandleColor getTextHandleColor()
          本文のハンドル色を取得します。
 JSHandleColor getTopicHandleColor()
          トピックのハンドル色を取得します。
 int getVisibleColumns()
          表示領界を取得します。
 boolean isChangeOddColor()
          行ごとに色を変更するかどうかを判定します。
 boolean isCheckBoxVisible()
          チェックボックスを表示するかどうかを判定します。
 boolean isMetadataNewLineByEnterKey()
          メタデータエディタにおいてEnterキーで改行するかどうかを判定します。
 void removeEventListener(String name, Object f)
          イベントリスナを削除します。
 boolean set(String path, jp.carabiner.treeeditor.config.DocumentStyle style, JSTreeNode node)
          推奨されていません。 
 boolean set(String path, JSTreeNode node)
          推奨されていません。 
 void setChangeOddColor(boolean enable)
          行ごとに色を変更するかどうかを設定します。
 void setCheckBoxVisible(boolean visible)
          チェックボックスを表示するかどうかを設定します。
 void setDefaultStyle(JSTreeNode node)
          デフォルトスタイルを設定します。
 void setHandleStyleClassname(String classname)
          ハンドルスタイルのクラス名を設定します。
 void setMetadataNewLineByEnterKey(boolean metadataNewLineByEnterKey)
          メタデータエディタにおいてEnterキーで改行するかどうかを設定します。
 void setNodeContentWidth(int nodeContentWidth)
          ノードのコンテンツ幅を設定します。
 void setOnclose(Object f)
          閉じるイベント用のハンドラを設定します。
 void setOnnodechange(Object f)
          ノード変更イベント用のハンドラを設定します。
 void setOnopen(Object f)
          開くイベント用のハンドラを設定します。
 void setOnpropchange(Object f)
          プロパティ変更イベント用のハンドラを設定します。
 void setRootNode(JSTreeNode newRootNode)
          ルートノードを設定します。
 void setVisibleColumns(int cols)
          表示領界を設定します。
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

JSDocument

public JSDocument(JSRunner jsRunner,
                  org.mozilla.javascript.Scriptable scope,
                  TreeEditorFrame frame)
構築します。

パラメータ:
jsRunner - 実行エンジン。nullは不可。
scope - スコープ。
frame - フレーム。nullは不可。
メソッドの詳細

dispose

public void dispose()
破棄します。


getScope

public org.mozilla.javascript.Scriptable getScope()
スコープを取得します。

定義:
インタフェース ToplevelObject 内の getScope
戻り値:
スコープ。

getOwnerOp

public jp.carabiner.treeeditor.op.CompositeOp getOwnerOp()
操作オーナーを取得します。

定義:
インタフェース ToplevelObject 内の getOwnerOp
戻り値:
操作オーナー。

getFileManager

public jp.carabiner.treeeditor.FileManager getFileManager()
インタフェース ToplevelObject の記述:
ファイルマネージャを取得します。

定義:
インタフェース ToplevelObject 内の getFileManager
戻り値:
ファイルマネージャ。

getDefaultDocumentStyle

public jp.carabiner.treeeditor.config.DocumentStyle getDefaultDocumentStyle()
ドキュメントスタイルのデフォルトを取得します。

戻り値:
ドキュメントスタイルのデフォルト。

set

@Deprecated
public boolean set(String path,
                              JSTreeNode node)
            throws IOException
推奨されていません。 

モデルを設定します。

パラメータ:
path - パス。nullは不可。
node - ノード。nullは不可。
戻り値:
インポートに成功した場合はtrue。
例外:
IOException - 入出力時のエラー。

set

@Deprecated
public boolean set(String path,
                              jp.carabiner.treeeditor.config.DocumentStyle style,
                              JSTreeNode node)
            throws IOException
推奨されていません。 

モデルを設定します。

パラメータ:
path - パス。nullは不可。
style - スタイル。nullは不可。
node - ノード。nullは不可。
戻り値:
インポートに成功した場合はtrue。
例外:
IOException - 入出力時のエラー。

setRootNode

public void setRootNode(JSTreeNode newRootNode)
インタフェース IJSDocument の記述:
ルートノードを設定します。

定義:
インタフェース IJSDocument 内の setRootNode
パラメータ:
newRootNode - ルートノード。

createTreeNode

public JSTreeNode createTreeNode(String text)
インタフェース IJSDocument の記述:
ツリーノードを生成します。

定義:
インタフェース IJSDocument 内の createTreeNode
パラメータ:
text - テキスト。nullは不可。
戻り値:
ツリーノード。

getRootNode

public JSTreeNode getRootNode()
インタフェース IJSDocument の記述:
ルートノードを取得します。

定義:
インタフェース IJSDocument 内の getRootNode
戻り値:
ルートノード。

getNodeStyles

public JSNodeStyles getNodeStyles()
ノードスタイルを取得します。

戻り値:
ノードスタイル。

getColumnHeaders

public JSColumnHeader[] getColumnHeaders()
カラムヘッダのリストを取得します。

戻り値:
カラムヘッダのリスト。

getFilename

public String getFilename()
ファイル名を取得します。

戻り値:
ファイル名。

getFilepath

public String getFilepath()
ファイルパスを取得します。

戻り値:
ファイルパス。

getOnclose

public Object getOnclose()
閉じるイベント用のハンドラを取得します。

戻り値:
ハンドラ。

setOnclose

public void setOnclose(Object f)
閉じるイベント用のハンドラを設定します。

パラメータ:
f - ハンドラ。

setOnopen

public void setOnopen(Object f)
開くイベント用のハンドラを設定します。

パラメータ:
f - ハンドラ。

getOnopen

public Object getOnopen()
開くイベント用のハンドラを取得します。

戻り値:
ハンドラ。

getPanelByNode

public jp.carabiner.treeeditor.ITreeNodePanel getPanelByNode(TreeNode node)
インタフェース ToplevelObject の記述:
パネルを取得します。

定義:
インタフェース ToplevelObject 内の getPanelByNode
パラメータ:
node - ノード。nullは不可。
戻り値:
パネル。見つからない場合はnull。

setOnpropchange

public void setOnpropchange(Object f)
プロパティ変更イベント用のハンドラを設定します。

パラメータ:
f - ハンドラ。

getOnpropchange

public Object getOnpropchange()
プロパティ変更イベント用のハンドラを取得します。

戻り値:
ハンドラ。

setOnnodechange

public void setOnnodechange(Object f)
ノード変更イベント用のハンドラを設定します。

パラメータ:
f - ハンドラ。

getOnnodechange

public Object getOnnodechange()
ノード変更イベント用のハンドラを取得します。

戻り値:
ハンドラ。

addEventListener

public void addEventListener(String name,
                             Object f)
イベントリスナを追加します。

パラメータ:
name - 名前。nullは不可。
f - リスナ。nullは不可。

removeEventListener

public void removeEventListener(String name,
                                Object f)
イベントリスナを削除します。

パラメータ:
name - 名前。nullは不可。
f - リスナ。nullは不可。

getVisibleColumns

public int getVisibleColumns()
表示領界を取得します。

戻り値:
表示領界。

setVisibleColumns

public void setVisibleColumns(int cols)
表示領界を設定します。

パラメータ:
cols - 表示領界。

getNodeContentWidth

public int getNodeContentWidth()
コンテンツ幅を取得します。

戻り値:
コンテンツ幅。

setNodeContentWidth

public void setNodeContentWidth(int nodeContentWidth)
ノードのコンテンツ幅を設定します。

パラメータ:
nodeContentWidth - ノードのコンテンツ幅。

isChangeOddColor

public boolean isChangeOddColor()
行ごとに色を変更するかどうかを判定します。

戻り値:
行ごとに色を変更する場合はtrue。

setChangeOddColor

public void setChangeOddColor(boolean enable)
行ごとに色を変更するかどうかを設定します。

パラメータ:
enable - 行ごとに色を変更する場合はtrue。

getTopicHandleColor

public JSHandleColor getTopicHandleColor()
トピックのハンドル色を取得します。

戻り値:
トピックのハンドル色。

getTextHandleColor

public JSHandleColor getTextHandleColor()
本文のハンドル色を取得します。

戻り値:
本文のハンドル色。

getDefaultStyle

public JSTreeNode getDefaultStyle()
デフォルトスタイルを取得します。

戻り値:
デフォルトスタイル。未指定の場合はnull。

setDefaultStyle

public void setDefaultStyle(JSTreeNode node)
デフォルトスタイルを設定します。

パラメータ:
node - デフォルトスタイルとするノード。nullにすると指定が解除される。

isCheckBoxVisible

public boolean isCheckBoxVisible()
チェックボックスを表示するかどうかを判定します。

戻り値:
チェックボックスを表示する場合はtrue。

setCheckBoxVisible

public void setCheckBoxVisible(boolean visible)
チェックボックスを表示するかどうかを設定します。

パラメータ:
visible - チェックボックスを表示する場合はtrue。

getHandleStyleClassname

public String getHandleStyleClassname()
ハンドルスタイルのクラス名を取得します。

戻り値:
ハンドルスタイルのクラス名。デフォルトの場合はnull。

setHandleStyleClassname

public void setHandleStyleClassname(String classname)
ハンドルスタイルのクラス名を設定します。

パラメータ:
classname - ハンドルスタイルのクラス名。デフォルトの場合はnull。

isMetadataNewLineByEnterKey

public boolean isMetadataNewLineByEnterKey()
メタデータエディタにおいてEnterキーで改行するかどうかを判定します。

戻り値:
メタデータエディタにおいてEnterキーで改行する場合はtrue。

setMetadataNewLineByEnterKey

public void setMetadataNewLineByEnterKey(boolean metadataNewLineByEnterKey)
メタデータエディタにおいてEnterキーで改行するかどうかを設定します。

パラメータ:
metadataNewLineByEnterKey - メタデータエディタにおいてEnterキーで改行する場合はtrue。

getInternalDocumentStyle

public jp.carabiner.treeeditor.config.DocumentStyle getInternalDocumentStyle()
インタフェース IJSDocument の記述:
内部管理用のDocumentStyleを取得します。

定義:
インタフェース IJSDocument 内の getInternalDocumentStyle
戻り値:
内部管理用のDocumentStyle。

getContext

public jp.carabiner.treeeditor.TreeEditorContext getContext()
インタフェース ToplevelObject の記述:
コンテキストを取得します。

定義:
インタフェース ToplevelObject 内の getContext
戻り値:
コンテキスト。

create

public Object create(org.mozilla.javascript.Scriptable scope)
              throws org.mozilla.javascript.RhinoException
定義:
インタフェース jp.carabiner.rhino.ScriptableObjectFactory 内の create
例外:
org.mozilla.javascript.RhinoException