アプリケーション
アプリケーションのインストール方法

BEITELでは、アプリケーションにより機能拡張をおこなうことができます。

配布されているアプリケーションをインストールする場合には、以下の操作を行ってください。

  1. アプリケーション管理画面を開く

    [ヘルプ]メニューの[アプリケーションの管理...]を選択してください。アプリケーション管理画面が表示されます。


  2. アップデートサイト(配布元サーバ)を登録する (公式サイト以外で配布されているアプリケーションをインストールする場合)

    [アップデートサイト]タブを開き、[新規Update Site]ボタンをクリックしてください。URLを入力するダイアログが表示されますので、URLを入力し[OK]ボタンをクリックしてください。

    一度アップデートサイトを登録すれば、2回目以降はこの操作を行う必要はありません。

  3. 新規アプリケーションを検索・インストールする

    [新規アプリケーション検索]ボタンをクリックしてください。アプリケーションが見つかると、見つかったアプリケーションの一覧が表示されますので、必要に応じてチェックをONにし、[インストール]ボタンをクリックしてください。


    必要に応じて、ライセンスの確認などのダイアログが開きますので、画面の指示にしたがってインストールを進めてください。

  4. BEITELを再起動する

    正常にインストール処理が完了すれば、インストールが完了した旨のメッセージが表示されます。BEITELを再起動すると、インストールされたアプリケーションが有効化されます。

正しくアプリケーションがインストールされている場合、メニューに機能が追加されます。

具体的にどのような機能が追加されるか、その使用方法はアプリケーションのドキュメントを参照してください。

オリジナルアプリケーションの作成方法

簡易アプリケーション

簡易アプリケーションとは、アップデートサイトを通じて配布をせず、個人的に利用するアプリケーションを記述する場合に便利なアプリケーションの形式です。

BEITELの簡易アプリケーションは、以下の手順で作成することができます。

  1. (BEITELをインストールしたフォルダ)\extにアプリケーションのメインとなるJavaScriptファイルを作成する

    このファイルは、BEITELがウィンドウを開く際に実行されます。文字コードはUTF-8で作成してください。

    (サンプル)

    Hello Worldサンプル([編集]メニューに[Hello]メニューを追加します。クリックするとメッセージボックスで"Hello, World!"と出力します):

    var item = window.menu.createMenuItem("Hello", function(ev){ alert("Hello, World!"); });
    window.menu.edit.appendChild(item);
    

  2. 必要に応じて、Javaコード・画像などの外部ファイルを作成し、jarファイルにまとめてext以下に配置する

    BEITELのJavaクラスを使用したい場合は、開発中はクラスパス内に(BEITELをインストールしたフォルダ)\lib\beitel.jarを含めるようにしてください。

  3. BEITELを起動する

    (すでにBEITELが起動している場合) [アプリを再読み込み]で、jarファイル(更新が検出された場合のみ)、JavaScriptファイルが再ロードされます。jarファイルを強制的に再読み込みしたい場合には、[アプリを完全再読み込み]で再読み込みできます。他、[ウィンドウを再オープン]によってウィンドウをいったん破棄し、一から再読み込みすることもできます。

アプリケーションの配布

BEITELでは、アップデートサイトを用意することで、このサイトを通じて独自アプリケーションを配布することができます。

BEITELアプリケーションは以下のルールに則ってアップデートサイトを作成することで、誰でも配布可能です。

  1. アプリケーションパッケージの作成

    アプリケーションパッケージとは、アプリケーション本体とその補助情報を格納したZIPファイルです。

    ZIPファイルは、以下のようなファイルで構成してください。

    • package.properties

      アプリケーションパッケージに関する情報を定義したファイルです。

      以下のようなキーと値のセットを定義したテキストファイルとして定義します。文字コードはUTF-8を使用してください。

      package.id=jp.carabiner.beitel.app.gecko
      package.name=BEITEL Gecko App (for Windows)
      package.version=0.1
      package.providerName=Carabiner Systems, Inc.
      requireLicenseAgreement=true
      licenseURL=agreement.txt
      icon.small=gecko-16.png
      icon.medium=gecko-32.png
      icon.large=gecko-64.png
      

      それぞれの項目の意味は以下のとおりです。

      • パッケージ情報定義

        • package.id

          パッケージIDを定義します。

          パッケージIDとは、アプリケーションパッケージを識別するためのIDで、(BEITELのインストールディレクトリ)/apps/パッケージID にアプリケーションパッケージの内容が展開されます。

          この定義は必須です。

        • package.name

          パッケージ名を定義します。

          パッケージ名は、アプリケーションの管理ダイアログなどにおいて、パッケージの名前として利用されます。

          この定義は必須です。

        • package.version

          バージョンを定義します。

          バージョンは、更新チェック時にパッケージが新しいかどうかを判定するために利用されます。以下のような形式が定義できます。

          • 0.1

          • 0.1_rc1

          • 0.1_rc2

          • 0.1_rc10

          • 1.0

          バージョン番号は 主バージョン番号とRC番号から構成することができ、以下のような順に新しいものとして解釈されます。

          0.1_rc1 < 0.1_rc2 < 0.1_rc10 < 0.1 < 1.0

          この定義は必須です。

        • package.providerName

          パッケージ提供者の名前です。

          アプリケーション管理ダイアログなどにおいて表示されます。

          この定義は必須です。

      • ライセンス定義

        • requireLicenseAgreement

          インストール・アップデート時に利用規約を表示し、それに同意させるかどうかを定義します。

          この値をtrueとした場合は、licenseURLキーの値を定義する必要があります。

          この定義は任意です。

        • licenseURL

          ライセンスファイルへのパスです。アプリケーションパッケージのルートに対する相対パスとして定義します。

      • アイコン定義

        • icon.small

          16×16のアイコンファイルへのパスを定義します。この定義は任意です。

        • icon.medium

          32×32のアイコンファイルへのパスを定義します。この定義は任意です。

        • icon.large

          64×64のアイコンファイルへのパスを定義します。この定義は任意です。

    • *.js

      パッケージのルート中にある.jsファイルはアプリケーションの起動時に実行されます。

      ここでは、.jar中のクラスを呼び出したり、APIにアクセスすることでBEITELに機能を追加することができます。

    • *.jar, **/*.jar

      パッケージ中に存在する拡張子.jarのファイルは、アプリケーションの起動時、.jsファイルの実行前に自動的にロードされます。

      ここに含まれる.classファイルおよびリソースファイルは、.jsファイルから参照することができます。

    • アイコンファイル

      package.propertiesに定義されたアイコンファイルを配置します。

      指定可能な形式は、image/png, image/jpeg, image/gifのいずれかです。

    • ライセンスファイル

      package.propertiesに定義された利用規約などの文章をまとめたテキストファイルを配置します。

      文字コードはUTF-8で保存してください。

  2. フィーチャーパッケージの作成

    フィーチャーパッケージとは、アプリケーションパッケージのうち、アプリケーションダウンロード時に表示すべきアイコン、ライセンス規約のみをまとめたZIPファイルです。

    アプリケーションパッケージのうち、以下のファイルを含めてください。

    • package.properties

    • アイコンファイル

    • ライセンスファイル

    なお、これらの情報をダウンロード時に表示する必要がない場合は、フィーチャーパッケージは不要です。

  3. アップデートサイト定義ファイルの作成

    アップデートサイト定義ファイルとは、あるサイトが配布するアプリケーションパッケージおよびそのバージョンの一覧をまとめたXMLファイルです。

    <?xml version="1.0" encoding="UTF-8"?>
    <update-site>
      <!-- Gecko --> 
      <package-def id="jp.carabiner.beitel.app.gecko" label="BEITEL Gecko App (for Windows)"> 
        <description>BEITEL Geckoアプリ (for Windows)</description> 
      </package-def> 
      <package 
               id="jp.carabiner.beitel.app.gecko" 
               version="0.1_rc1" 
               archive="beitel-gecko-0.1_rc1.zip"/> 
      <package 
               id="jp.carabiner.beitel.app.gecko" 
               version="0.1" 
               archive="beitel-gecko-0.1.zip"
               feature="beitel-gecko-feature-0.1.jar"/> 
      ...
    </update-site>
    

    それぞれの要素の意味は以下のとおりです。

    • update-site

      アップデートサイト定義ファイルのルート要素です。

    • pacakge-def

      • 機能

        パッケージIDが示すパッケージに関する情報を定義します。

      • 属性

        • id

          パッケージIDを定義します。

        • label

          パッケージ内容の表示時のラベルを定義します。

      • 要素

        • description

          パッケージに関する詳細説明を定義します。

    • package

      • 機能

        特定バージョンのパッケージの内容を定義します。

      • 属性

        • id

          パッケージIDを定義します。

        • version

          パッケージのバージョンを定義します。

        • archive

          アプリケーションパッケージへのパスを定義します。

        • feature

          フィーチャーパッケージへのパスを定義します。

  4. アップデートサイトURLの配布

    アップデートサイトとアプリケーションパッケージ、フィーチャーパッケージをWWWサーバにアップロードします。

    ユーザに対してアップデートサイト定義ファイルのURLを配布してください。

アプリケーションから呼び出し可能なAPI

概要図

BEITELのAPIは以下のような構成となっています。


グローバルオブジェクトdocument, window, beitelから、APIの提供する各機能にアクセスすることができます。

グローバルオブジェクト

window

機能

現在スクリプトが実行されているウィンドウに対応するフレームを表現します。

プロパティ

menu

ウィンドウのメニューバーを表現するオブジェクトです。読み込みのみ可能です。

Menuタイプのオブジェクトです。

onclick

ノードのクリック時に呼び出されるイベントハンドラです。

Functionタイプのオブジェクトです。第一引数にClickEvent型のオブジェクトが設定されます。

onclose

ウィンドウが閉じる時に呼び出されるイベントハンドラです。

Functionタイプのオブジェクトです。第一引数にEvent型のオブジェクトが設定されます。

ondblclick

ノードのダブルクリック時に呼び出されるイベントハンドラです。

Functionタイプのオブジェクトです。第一引数にClickEvent型のオブジェクトが設定されます。

oninitialize

ウィンドウが開かれた後、メニュー等の初期化が完了した時に呼び出されるイベントハンドラです。

Functionタイプのオブジェクトです。第一引数にEvent型のオブジェクトが設定されます。

onopen

ウィンドウが開かれた時に呼び出されるイベントハンドラです。

Functionタイプのオブジェクトです。第一引数にEvent型のオブジェクトが設定されます。

onselect

ノードの選択状態の変更時に呼び出されるイベントハンドラです。

Functionタイプのオブジェクトです。第一引数にSelectionEvent型のオブジェクトが設定されます。

onhoiststart

ホイスト開始時に呼び出されるイベントハンドラです。

Functionタイプのオブジェクトです。第一引数にHoistEvent型のオブジェクトが設定されます。

onhoistend

ホイスト終了時に呼び出されるイベントハンドラです。

Functionタイプのオブジェクトです。第一引数にHoistEvent型のオブジェクトが設定されます。

popup

ノードでの右クリック時メニューを表現するオブジェクトです。読み込みのみ可能です。

Menuタイプのオブジェクトです。

swingFrame

フレームに対応するSwingオブジェクトです。読み込みのみ可能です。

javax.swing.JFrameのインスタンスです。

selectedNodes

選択されているノードのリストです。読み込みのみ可能です。

ノードが選択されていない場合はnull、それ以外はNodeListタイプのオブジェクトです。

settings

アプリケーションの設定保存・取得用のオブジェクトです。

appsフォルダ内のアプリケーションから呼び出した場合、Settingsオブジェクトが返されます。設定の保持・取得方法についてはSettingsオブジェクトの説明を参照してください。

extフォルダ内のスクリプトから呼び出した場合、nullが返されます。

toplevelSelectedNodes

選択されているノードのうち、トップレベル(これ以上選択されている親がない)ノードです。読み込みのみ可能です。

ノードが選択されていない場合はnull、それ以外はNodeListタイプのオブジェクトです。

formatManager

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

FormatManagerタイプのオブジェクトです。

thumbnailManager

サムネイルのレンダリング方法を管理するマネージャです。読み込みのみ可能です。

ThumbnailManagerタイプのオブジェクトです。

関数プロパティ

addEventListener(String, Function)
機能

イベントリスナを登録します。

引数
  • イベント名

    イベントの名前を指定します。click,close,dblclick,initialize,open,selectのいずれかが指定可能です。

  • 関数

    イベント発生時に実行する関数を指定します。

戻り値

なし

removeEventListener(String, Function)
機能

イベントリスナの登録を解除します。

引数
  • イベント名

    イベントの名前を指定します。click,close,dblclick,initialize,open,selectのいずれかが指定可能です。

  • 関数

    イベント発生時に実行する関数を指定します。

戻り値

なし

getFile(String)
機能

引数pathを相対パスとして、アプリケーション内のファイルを取得します。

appsフォルダ内のアプリケーションから呼び出した場合は、(BEITELのディレクトリ)/apps/(パッケージID)/(path)が返されます。

extフォルダ内のスクリプトから呼び出した場合は、ext/(path)が返されます。

引数
  • パス

    参照したいファイルの相対パスを指定します。

戻り値

java.io.Fileが返されます。

getPersistentFile(String)
機能

引数pathを相対パスとして、アプリケーションに関する作業ファイルを取得します。

このファイルはアプリケーションのアップデート時などに削除されることはないため、永続的な設定保存領域として利用することなどが可能です。

appsフォルダ内のアプリケーションから呼び出した場合は、(BEITELのディレクトリ)/apps/.local.(パッケージID)/persistent/(path)が返されます。

extフォルダ内のスクリプトから呼び出した場合は、nullが返されます。

引数
  • パス

    参照したいファイルの相対パスを指定します。

戻り値

java.io.Fileが返されます。

openEncryptedInputStream(String)
機能

引数pathが示す永続化ファイルを暗号化ストリームとみなし、データを読み込むための入力ストリームを取得します。

getPersistentFile(String)の規約にしたがってファイルが作成されます。extフォルダ内のスクリプトから呼び出した場合は、例外が発生します。

引数
  • パス

    参照したいファイルの相対パスを取得します。

戻り値

java.io.InputStreamが返されます。

openEncryptedOutputStream(String)
機能

引数pathが示す永続化ファイルを暗号化ストリームとみなし、データを書き込むための出力ストリームを取得します。

getPersistentFile(String)の規約にしたがってファイルが作成されます。extフォルダ内のスクリプトから呼び出した場合は、例外が発生します。

引数
  • パス

    保存したいファイルの相対パスを取得します。

戻り値

java.io.OutputStreamが返されます。

getJSRunner()
機能

JavaScriptを非同期実行するためのオブジェクト JSRunner を取得します。

詳しい使用方法は jp.carabiner.treeeditor.js.JSRunnerクラス を参照してください。

引数

なし

戻り値

jp.carabiner.treeeditor.js.JSRunnerオブジェクトが返されます。

document

機能

現在ウィンドウで開かれているドキュメントを表現します。

プロパティ

rootNode

ドキュメントのルートとなるノードです。読み込みのみ可能です。

TreeNodeタイプのオブジェクトです。

nodeStyles

ノードスタイル(文字色・背景色)を表現するノードです。

NodeStyleListタイプのオブジェクトです。

columnHeaders

カラムヘッダの一覧を示す配列です。

読み込みのみ可能です。(カラムヘッダの追加などはできません。)

Arrayタイプのオブジェクトです。要素にはColumnHeaderタイプのオブジェクトが格納されます。

filename

現在開いているZTEファイルの名前を示す文字列です。読み込みのみ可能です。

ファイルを開いていない場合はnullが返されます。

filepath

現在開いているZTEファイルが格納されているディレクトリのパスを示す文字列です。読み込みのみ可能です。

ファイルを開いていない場合はnullが返されます。

onclose

ドキュメントが閉じる時に呼び出されるイベントハンドラです。

Functionタイプのオブジェクトです。第一引数にEvent型のオブジェクトが設定されます。

onnodechange

ノードの構造が変化した時に呼び出されるイベントハンドラです。

Functionタイプのオブジェクトです。第一引数にNodeChangeEvent型のオブジェクトが設定されます。

onopen

ドキュメントが開く時に呼び出されるイベントハンドラです。

Functionタイプのオブジェクトです。第一引数にEvent型のオブジェクトが設定されます。

onpropchange

ノードのプロパティが変化した時に呼び出されるイベントハンドラです。

Functionタイプのオブジェクトです。第一引数にPropChangeEvent型のオブジェクトが設定されます。

visibleColumns

表示領界に含めるカラム数を示す整数値です。

changeOddColor

行ごとに色を変更するかどうかを示すBoolean値です。

nodeContentWidth

ノードテキストの幅を示す整数値です。

topicHandleColor

トピックのハンドル色を示すオブジェクトです。

HandleColorタイプのオブジェクトです。

textHandleColor

本文のハンドル色を示すオブジェクトです。

HandleColorタイプのオブジェクトです。

defaultStyle

ノードの既定スタイルを表現するノードです。

TreeNodeタイプのオブジェクトです。

checkBoxVisible

チェックボックスを表示するかどうかを示すBoolean値です。

handleStyleClassname

ハンドルスタイルを示す文字列です。

デフォルトスタイルの場合はnullが返されます。

関数プロパティ

addEventListener(String, Function)
機能

イベントリスナを登録します。

引数
  • イベント名

    イベントの名前を指定します。close,nodechange,open,propchangeのいずれかが指定可能です。

  • 関数

    イベント発生時に実行する関数を指定します。

戻り値

なし

createTreeNode(String)
機能

ツリーノードを新規作成します。

引数
  • ノード文字列

    ノードに設定する文字列を指定します。

戻り値

ツリーノードが返されます。

サンプル
var treeNode = document.createTreeNode("ノード名");
document.rootNode.appendChild(treeNode);
removeEventListener(String, Function)
機能

イベントリスナの登録を解除します。

引数
  • イベント名

    イベントの名前を指定します。close,nodechange,open,propchangeのいずれかが指定可能です。

  • 関数

    イベント発生時に実行する関数を指定します。

戻り値

なし

beitel

機能

BEITELアプリケーションに関する情報を表現します。

プロパティ

id

BEITELコアのID文字列です。

version

BEITELコアのバージョン文字列です。

myApplication

このアプリケーションを表現するオブジェクトです。

BEITELApplicationタイプのオブジェクトが返されます。

関数プロパティ

なし

グローバル関数

alert(String)
機能

メッセージボックスを表示します。

引数
  • メッセージ

    出力するメッセージを指定します。

戻り値

なし

サンプル
alert("テストです!");
confirm(String)
機能

確認ダイアログボックスを表示します。

引数
  • メッセージ

    ダイアログに表示するメッセージを指定します。

戻り値

[OK]ボタンが選択されればtrue、[キャンセル]ボタンが選択されればfalse。

importFile(String)
機能

外部jsファイルをインポートします。

引数
  • パス

    インポートしたい.jsファイルのパス。

    extディレクトリを起点とした相対パスで指定してください。

戻り値

なし

createNewWindow()
機能

新しいウィンドウを開きます。

引数

なし

戻り値

なし

オブジェクトの型

Event

機能

特にパラメータをともなわないイベントを表現します。

プロパティ

type

イベント名を示す文字列です。読み込みのみ可能です。

関数プロパティ

preventDefault
機能

イベントのデフォルト処理をキャンセルします。

BEITELApplication.detachイベントでのみ利用可能です。

引数

なし

戻り値

なし

ClickEvent

機能

ノードクリック時のイベントを表現します。

プロパティ

source

イベントの発生元のノードを取得します。読み込みのみ。

TreeNodeタイプのオブジェクトです。

type

イベント名を示す文字列です。読み込みのみ可能です。

関数プロパティ

なし

SelectionEvent

機能

ノードの選択状態変更時のイベントを表現します。

プロパティ

selectedNodes

選択されているノードの一覧です。読み込みのみ。

TreeNodeタイプのオブジェクトの配列です。

toplevelSelectedNodes

選択されているノード(トップレベル(これ以上選択されている親がない))の一覧です。読み込みのみ。

TreeNodeタイプのオブジェクトの配列です。

type

イベント名を示す文字列です。読み込みのみ可能です。

関数プロパティ

なし

HoistEvent

機能

ホイスト状態変更時のイベントを表現します。

プロパティ

targetNode

ホイストされたノードです。読み込みのみ。

TreeNodeタイプのオブジェクトです。ホイスト終了時にはnullが設定されます。

type

イベント名を示す文字列です。読み込みのみ可能です。

hoiststart, hoistendのいずれかになります。

関数プロパティ

なし

NodeChangeEvent

機能

ノード構造の変更時のイベントを表現します。

プロパティ

action

操作の内容を示す整数値です。読み込みのみ。

ノード追加: 1, ノード削除: 2

source

親ノードです。読み込みのみ。

TreeNodeタイプのオブジェクトです。

child

子ノードです。読み込みのみ。

TreeNodeタイプのオブジェクトです。

type

イベント名を示す文字列です。読み込みのみ可能です。

関数プロパティ

なし

PropChangeEvent

機能

ノードのプロパティ変更時のイベントを表現します。

プロパティ

property

変更されたプロパティを示す整数値です。読み込みのみ。

テキスト: 1, 展開状態 2, ノード番号: 3, チェック状態: 4, 箇条書きタイプ: 5

更新時刻: 6, 作成時刻: 7, 画像などのデータ: 8, トピック/本文: 9, 文字色: 10

背景色: 11, 編集可能かどうか: 12

source

ノードです。読み込みのみ。

TreeNodeタイプのオブジェクトです。

value

変更後の値です。読み込みのみ。

TreeNodeタイプのオブジェクトです。

type

イベント名を示す文字列です。読み込みのみ可能です。

関数プロパティ

なし

Menu

機能

メニューを表現します。

プロパティ

file

ファイルメニューです。読み込みのみ可能です。

MenuContainerタイプのオブジェクトです。

edit

編集メニューです。読み込みのみ可能です。

MenuContainerタイプのオブジェクトです。

help

ヘルプメニューです。読み込みのみ可能です。

MenuContainerタイプのオブジェクトです。

childNodes

子ノードのリストです。読み込みのみ可能です。

NodeListタイプのオブジェクトです。

関数プロパティ

createMenuItem(String,Function)
機能

新規にメニューアイテムを作成します。

引数
  • メニュー項目名

    メニュー項目として表示する名前を指定します。

  • ハンドラ

    メニュー選択時に実行する処理を指定します。

    このハンドラにはMenuEventタイプのオブジェクトが引数として渡されます。

戻り値

メニューアイテムが返されます。

MenuItemタイプのオブジェクトです。

サンプル
var comp = window.menu.createMenuItem("メニュー1",
                                           function(ev){alert("メニュー1");});
window.menu.file.appendChild(comp);
createMenuContainer(String)
機能

新規にメニューコンテナを作成します。

引数
  • メニュー項目名

    メニュー項目として表示する名前を指定します。

戻り値

メニューコンテナが返されます。

MenuContainerタイプのオブジェクトです。

サンプル
var container = window.menu.createMenuContainer("メニュー2");
window.menu.file.appendChild(container);
var comp = window.menu.createMenuItem("メニュー2アイテム",
                                 function(ev){alert("メニュー2");});
container.appendChild(comp);
createSeparator()
機能

新規に区切り線を作成します。

引数
戻り値

区切り線が返されます。

Componentタイプのオブジェクトです。

サンプル
var comp = window.menu.createSeparator();
window.menu.file.appendChild(comp);
appendChild(node)
機能

メニューバーにアイテムを追加します。

引数
  • 新規アイテム

    メニューバーに追加するアイテムを指定します。

    MenuContainerタイプのオブジェクトを指定することができます。

戻り値

追加されたアイテムが返されます。

insertBefore(newNode, refNode)
機能

メニューバーの指定位置にアイテムを追加します。

引数
  • 新規アイテム

    メニューバーに追加するアイテムを指定します。

    MenuContainerタイプのオブジェクトを指定することができます。

  • 追加先アイテム

    メニュー項目の追加先を指定します。

戻り値

追加されたアイテムが返されます。

removeChild(node)
機能

メニューバーから指定されたアイテムを削除します。

引数
  • 削除するアイテム

    メニューバーから削除するアイテムを指定します。

戻り値

削除されたアイテムが返されます。

MenuItem

機能

メニューアイテムを表現します。

プロパティ

icon

アイコンとなるファイルを指定します。設定のみで取得はできません。

ファイルはjarファイル内に格納され、クラスパス(beitel.exeのあるディレクトリのlibもしくはext以下)内に存在する必要があります。

key

ショートカットキーのキーコードを取得します。読み込みのみ。

java.awt.event.KeyEvent.VK_*で示されるキーコードが格納されます。ショートカットキーが指定されていない場合は0です。

modifier

ショートカットキーのAlt,Ctrlなどの修飾子を取得します。読み込みのみ。

java.awt.event.InputEvent.SHIFT_DOWN_MASKなどの修飾子の論理和が格納されます。ショートカットキーが指定されていない場合は0です。

text

メニューのテキストを設定・取得します。

tooltips

メニューのツールチップを設定・取得します。

parentNode

親ノードへの参照です。読み込みのみ可能です。

Menu, MenuContainerタイプのうちいずれかのオブジェクトです。

関数プロパティ

setKeyStroke(Number,Number)
機能

ショートカットキーを指定します。

引数
  • キーコード

    ショートカットのキーコードを指定します。

    keyプロパティに対応します。

  • 修飾子

    ショートカットの修飾子を指定します。

    modifierプロパティに対応します。

戻り値

なし

サンプル
var comp = window.menu.createMenuItem("メニュー3",
                                           function(ev){alert("メニュー3");});
comp.setKeyStroke(java.awt.event.KeyEvent.VK_H,
                java.awt.Event.SHIFT_MASK|java.awt.Event.CTRL_MASK);
window.menu.file.appendChild(comp);

MenuEvent

機能

メニュー選択時のイベントを表現します。

プロパティ

currentTarget

イベントの発生元のノードを取得します。読み込みのみ。

TreeNodeタイプのオブジェクトです。

関数プロパティ

なし

MenuContainer

機能

メニューコンテナ(子メニューを持つことができるメニュー)を表現します。

プロパティ

icon

アイコンとなるファイルを指定します。設定のみで取得はできません。

ファイルはjarファイル内に格納され、クラスパス(beitel.exeのあるディレクトリのlibもしくはext以下)内に存在する必要があります。

key

ショートカットキーのキーコードを取得します。読み込みのみ。

java.awt.event.KeyEvent.VK_*で示されるキーコードが格納されます。ショートカットキーが指定されていない場合は0です。

modifier

ショートカットキーのAlt,Ctrlなどの修飾子を取得します。読み込みのみ。

メニューコンテナの場合この値は常に0です。

text

メニューのテキストを設定・取得します。

tooltips

メニューのツールチップを設定・取得します。

childNodes

子ノードのリストです。読み込みのみ可能です。

NodeListタイプのオブジェクトです。

parentNode

親ノードへの参照です。読み込みのみ可能です。

Menu, MenuContainerタイプのうちいずれかのオブジェクトです。

関数プロパティ

appendChild(node)
機能

メニューコンテナにアイテムを追加します。

引数
  • 新規アイテム

    メニューコンテナに追加するアイテムを指定します。

    MenuContainerタイプもしくはMenuItemタイプのオブジェクトを指定することができます。

戻り値

追加されたアイテムが返されます。

insertBefore(newNode, refNode)
機能

メニューコンテナの指定位置にアイテムを追加します。

引数
  • 新規アイテム

    メニューコンテナに追加するアイテムを指定します。

    MenuContainerタイプもしくはMenuItemタイプのオブジェクトを指定することができます。

  • 追加先アイテム

    メニュー項目の追加先を指定します。

戻り値

追加されたアイテムが返されます。

removeChild(node)
機能

メニューコンテナから指定されたアイテムを削除します。

引数
  • 削除するアイテム

    メニューコンテナから削除するアイテムを指定します。

戻り値

削除されたアイテムが返されます。

setKeyStroke(Number,Number)
機能

ショートカットキー(Alt+キーコード)を指定します。

引数
  • キーコード

    ショートカットのキーコードを指定します。

    keyプロパティに対応します。

  • 修飾子

    ショートカットの修飾子を指定します。

    MenuItemタイプとインタフェースを共通にするために用意してある引数です。この値には常に0を指定する必要があります。

戻り値

なし

サンプル
var container = window.menu.createMenuContainer("メニュー4(T)");
container.setKeyStroke(java.awt.event.KeyEvent.VK_T, 0);
window.menu.file.appendChild(container);
var comp = window.menu.createMenuItem("メニュー4アイテム",
                                 function(ev){alert("メニュー4");});
container.appendChild(comp);

TreeNode

機能

ドキュメントを構成するノードを表現します。

プロパティ

text

ノードの文字列です。文字修飾に関する情報は含まれません。

html

文字修飾を含むノードの文字列です。文字修飾に関する情報はHTMLタグとして表現されます。

number

ノードの番号です。読み込みのみ可能です。

updateTime

ノードの更新日時です。

1970 年 1 月 1 日 00:00:00 GMT からのミリ秒数値です。

createTime

ノードの作成日時です。

1970 年 1 月 1 日 00:00:00 GMT からのミリ秒数値です。

expand

ノードが展開されているかどうかを示すBoolean値です。

ノードが展開されていればtrue、それ以外はfalseです。

selected

ノードが選択されているかどうかを示すBoolean値です。

ノードが選択されていればtrue、それ以外はfalseです。

nodeType

ノードがトピックであるかどうかを示すString値です。

ノードがトピックであれば"topic"、それ以外は"text"です。

foreground

文字色を示すjava.awt.Colorオブジェクトです。

このノードに文字色が指定されていれば文字色を示すjava.awt.Colorオブジェクト、指定されていない場合はnullです。

background

背景色を示すjava.awt.Colorオブジェクトです。

このノードに背景色が指定されていれば背景色を示すjava.awt.Colorオブジェクト、指定されていない場合はnullです。

textEditable

テキストが編集可能であるかどうかを示すBoolean値です。

テキストが編集可能であればtrue、それ以外はfalseです。

panelEditable

このノード(カラム含む)が編集可能であるかどうかを示すBoolean値です。

この値はこのウィンドウの実行中でのみ有効です。ファイルに保存されることはありません。

このノードが編集可能であればtrue、それ以外はfalseです。

imageData

画像データを取得するための入力ストリームを取得します。読み込みのみ可能です。

java.io.InputStreamのインスタンスです。このノードに画像が設定されていない場合はnullです。

imageFilename

画像データのファイル名を取得します。読み込みのみ可能です。

このノードに画像が設定されていればファイル名を示す文字列、設定されていない場合はnullです。

fileData

添付ファイルデータを取得するための入力ストリームを取得します。読み込みのみ可能です。

java.io.InputStreamのインスタンスです。このノードに添付ファイルが設定されていない場合はnullです。

filename

添付ファイルのファイル名を取得します。読み込みのみ可能です。

このノードに添付ファイルが設定されていればファイル名を示す文字列、設定されていない場合はnullです。

fileLastModified

添付ファイルの更新日時を取得します。読み込みのみ可能です。

このノードに添付ファイルが設定されていれば更新日時、設定されていない場合は-1です。

1970 年 1 月 1 日 00:00:00 GMT からのミリ秒数値です。

childNodes

子ノードのリストです。読み込みのみ可能です。

NodeListタイプのオブジェクトです。

parentNode

親ノードへの参照です。読み込みのみ可能です。

TreeNodeタイプのオブジェクトです。

関数プロパティ

appendChild(node)
機能

ノードに子ノードを追加します。

引数
  • 新規ノード

    このノードに追加するノードを指定します。

    TreeNodeタイプのオブジェクトを指定することができます。

戻り値

追加されたノードが返されます。

insertBefore(newNode, refNode)
機能

ノードの指定位置に子ノードを追加します。

引数
  • 新規ノード

    このノードに追加するノードを指定します。

    TreeNodeタイプのオブジェクトを指定することができます。

  • 追加先ノード

    ノードの追加先を示すノードを指定します。

戻り値

追加されたノードが返されます。

removeChild(node)
機能

このノードから指定されたノードを削除します。

引数
  • 削除するノード

    ノードから削除するノードを指定します。

戻り値

削除されたノードが返されます。

setImage(String,InputStream)
機能

このノードに画像を設定します。

2つの引数にnullを指定することで、このノードに対する画像指定を解除することができます。

引数
  • ファイル名

    画像ファイル名を指定します。

    画像を解除する場合はnullを指定してください。

  • 画像データ

    画像データを供給する入力ストリームを指定してください。

    java.io.InputStreamのインスタンスを指定してください。

    画像を解除する場合はnullを指定してください。

戻り値

なし

setFile(String,long,InputStream)
機能

このノードに添付ファイルを設定します。

第一引数および第三引数にnullを指定することで、このノードに対する添付ファイル指定を解除することができます。

引数
  • ファイル名

    添付ファイル名を指定します。

    添付を解除する場合はnullを指定してください。

  • 最終更新時刻

    添付データの更新時刻を指定します。

  • 添付データ

    添付データを供給する入力ストリームを指定してください。

    java.io.InputStreamのインスタンスを指定してください。

    添付を解除する場合はnullを指定してください。

戻り値

なし

getColumn(int)
機能

このノードに付随するカラムを取得します。

引数
  • カラムのインデックス

    カラムのインデックスを指定します。

    インデックスは0,1,2,...の順番に左から右に付与されます。

戻り値

カラムを表現するColumnオブジェクトが返されます。

renderPNGImage(int,int)
機能

このノードに関連付けられている画像と添付ファイルを画像にレンダリングします。

引数
  • 推奨幅

    出力する画像の推奨幅を指定します。

  • 推奨高さ

    出力する画像の推奨高さを指定します。

戻り値

画像データを格納したストリームが返されます。java.io.InputStream型のオブジェクトです。

ColumnHeader

機能

カラムのヘッダ部分を表現します。

プロパティ

text

カラムヘッダに表示する文字列です。

visible

カラムヘッダが表示状態であるかどうかを示すBoolean値です。

表示状態であればtrue、非表示状態であればfalseとなります。

width

カラムヘッダの幅です。

textEditable

このヘッダーが示す列において、テキストが編集可能であるかどうかを示すBoolean値です。

テキストが編集可能であればtrue、それ以外はfalseです。

Column

機能

ノードに付随するカラムを表現します。

プロパティ

text

ノードの文字列です。文字修飾に関する情報は含まれません。

html

文字修飾を含むノードの文字列です。文字修飾に関する情報はHTMLタグとして表現されます。

textEditable

テキストが編集可能であるかどうかを示すBoolean値です。

テキストが編集可能であればtrue、それ以外はfalseです。

NodeList

機能

ドキュメントを構成するノード、メニューなどの構成要素のリストを表現します。

プロパティ

length

リストの長さです。読み込みのみ可能です。

関数プロパティ

item(Number)
機能

ノードから要素を取得します。

Arrayと同様、[Number]によりアイテムを取得することも可能です。

引数
  • インデックス

    取得したい要素のインデックスを指定します。

戻り値

指定されたインデックスに対応する要素が返されます。

Settings

機能

設定情報を取得・参照するためのオブジェクトです。

関数プロパティ

createBooleanEntry(String, boolean)
機能

設定情報内に真偽値保持用のエントリ定義を生成します。

引数
  • パラメータ名

    エントリの名前を指定します。

  • デフォルト値

    エントリのデフォルト値を指定します。

戻り値

なし

createIntegerEntry(String, int)
機能

設定情報内に整数保持用のエントリ定義を生成します。

引数
  • パラメータ名

    エントリの名前を指定します。

  • デフォルト値

    エントリのデフォルト値を指定します。

戻り値

なし

createStringEntry(String, String)
機能

設定情報内に文字列保持用のエントリ定義を生成します。

引数
  • パラメータ名

    エントリの名前を指定します。

  • デフォルト値

    エントリのデフォルト値を指定します。

戻り値

なし

getBoolean(String)
機能

引数で示されるパラメータの値を真偽値として取得します。

引数
  • パラメータ名

    パラメータの名前を指定します。

戻り値

現在のパラメータの値。

getInteger(String)
機能

引数で示されるパラメータの値を整数値として取得します。

引数
  • パラメータ名

    パラメータの名前を指定します。

戻り値

現在のパラメータの値。

getString(String)
機能

引数で示されるパラメータの値を文字列値として取得します。

引数
  • パラメータ名

    パラメータの名前を指定します。

戻り値

現在のパラメータの値。

setBoolean(String, boolean)
機能

引数で示されるパラメータの値を真偽値として設定します。

引数
  • パラメータ名

    パラメータの名前を指定します。

  • パラメータの値を指定します。

戻り値

なし

setInteger(String, int)
機能

引数で示されるパラメータの値を整数値として設定します。

引数
  • パラメータ名

    パラメータの名前を指定します。

  • パラメータの値を指定します。

戻り値

なし

setString(String, String)
機能

引数で示されるパラメータの値を文字列値として設定します。

引数
  • パラメータ名

    パラメータの名前を指定します。

  • パラメータの値を指定します。

戻り値

なし

NodeStyleList

機能

ノードスタイルのリストを表現するオブジェクトです。

プロパティ

length

ノードスタイルの数を示すNumber値です。読み込みのみ。

関数プロパティ

add(name, foreground, background)
機能

ノードスタイル定義を追加します。

引数
  • ノードスタイル名

    ノードスタイルの名前を指定します。

    String値を指定することができます。

  • 文字色

    文字色を指定します。

    java.awt.Colorオブジェクトを指定することができます。指定しない場合はnullです。

  • 背景色

    背景色を指定します。

    java.awt.Colorオブジェクトを指定することができます。指定しない場合はnullです。

戻り値

特にありません。

findByName(name)
機能

ノードスタイル定義を検索します。

引数
  • ノードスタイル名

    検索したいノードスタイルの名前を指定します。

    String値を指定することができます。

戻り値

検索結果のノードスタイル。見つからない場合はnullが返されます。

get(index)
機能

ノードスタイル定義を取得します。

引数
  • ノードインデックス

    取得したいノードスタイルのインデックスを指定します。

    Number値を指定することができます。

戻り値

インデックスに対応するノードスタイル。インデックスの値が定義されている個数以上の場合はエラーがスローされます。

remove(index)
機能

ノードスタイル定義を削除します。

引数
  • ノードインデックス

    取得したいノードスタイルのインデックスを指定します。

    Number値を指定することができます。

戻り値

特にありません。

set(index, name, foreground, background)
機能

ノードスタイル定義を更新します。

引数
  • ノードインデックス

    更新したいノードスタイルのインデックスを指定します。

    Number値を指定することができます。

  • ノードスタイル名

    ノードスタイルの名前を指定します。

    String値を指定することができます。

  • 文字色

    文字色を指定します。

    java.awt.Colorオブジェクトを指定することができます。指定しない場合はnull。

  • 背景色

    背景色を指定します。

    java.awt.Colorオブジェクトを指定することができます。指定しない場合はnull。

戻り値

特にありません。

NodeStyle

機能

ノードスタイルを表現するオブジェクトです。

プロパティ

name

ノードスタイル名を示すString値です。読み込みのみ。

foreground

文字色を示すjava.awt.Colorオブジェクトです。読み込みのみ。

未指定の場合はnullです。

background

背景色を示すjava.awt.Colorオブジェクトです。読み込みのみ。

未指定の場合はnullです。

HandleColor

機能

ハンドル色を表現するオブジェクトです。

プロパティ

background1

背景色1を示すjava.awt.Colorオブジェクトです。

background2

背景色2を示すjava.awt.Colorオブジェクトです。

border

境界色を示すjava.awt.Colorオブジェクトです。

faceHighlight

表面のハイライトを示すjava.awt.Colorオブジェクトです。

faceShadow

表面の影を示すjava.awt.Colorオブジェクトです。

FormatManager

機能

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

プロパティ

childNodes

現在登録されているフォーマットのリストです。読み込みのみ可能です。

FormatListタイプのオブジェクトです。

関数プロパティ

appendChild(format)
機能

マネージャに形式を追加します。

引数
  • 新規形式

    マネージャに追加する形式を指定します。

    Formatタイプのオブジェクトを指定することができます。

戻り値

追加された形式が返されます。

createFormat(ext)
機能

指定した拡張子に対して読み込み・書き込みを行うような形式を生成します。

生成された形式オブジェクトは、appendChildされるまで有効になりません。

引数
  • 拡張子リスト

    生成する形式が処理すべき拡張子のリストを指定します。

    文字列のArrayである必要があります。大文字小文字は区別されません。

戻り値

形式を示すFormatオブジェクトが返されます。

insertBefore(newFormat, refFormat)
機能

マネージャの指定位置に形式を追加します。

引数
  • 新規形式

    マネージャに追加する形式を指定します。

    Formatタイプのオブジェクトを指定することができます。

  • 追加先

    追加先を示す形式を指定します。

戻り値

追加された形式が返されます。

removeChild(format)
機能

マネージャから指定された形式を削除します。

引数
  • 削除する形式

    削除する形式を指定します。

戻り値

削除された形式が返されます。

FormatList

機能

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

プロパティ

length

リストの長さです。読み込みのみ可能です。

関数プロパティ

item(Number)
機能

ノードから要素を取得します。

Arrayと同様、[Number]によりアイテムを取得することも可能です。

引数
  • インデックス

    取得したい要素のインデックスを指定します。

戻り値

指定されたインデックスに対応する要素が返されます。

Formatタイプのオブジェクトです。

Format

機能

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

プロパティ

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を返します。

LoadContext

機能

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

プロパティ

path

読み込み対象のパスです。

関数プロパティ

createModel()
機能

モデルを生成します。このモデルに読み込んだモデルを設定します。

引数

なし

戻り値

生成したモデルを返します。

FormatDocumentタイプのオブジェクトです。

info(String)
機能

ファイル読み込みに関する通知文字列を設定します。

引数
  • メッセージ

    通知したいメッセージ文字列を指定します。

戻り値

なし

warning(String)
機能

ファイル読み込みに関する警告文字列を設定します。

引数
  • メッセージ

    警告したいメッセージ文字列を指定します。

戻り値

なし

createIndeterminateProgress(String)
機能

進行率が明示できない処理であることを示し、進行率報告用オブジェクトを生成します。

引数
  • メッセージ

    処理中ダイアログに表示したいメッセージ文字列を指定します。

戻り値

進行率を管理するためのオブジェクトを返します。

Progressタイプのオブジェクトです。

createDeterminateProgress(String, int)
機能

進行率が明示できる処理であることを示し、進行率報告用オブジェクトを生成します。

引数
  • メッセージ

    処理中ダイアログに表示したいメッセージ文字列を指定します。

  • 完了までのタスク数

    完了までのタスク数を指定します。

    Progressオブジェクトの progress() を呼び出すと1タスク完了したとみなされます。

戻り値

進行率を管理するためのオブジェクトを返します。

Progressタイプのオブジェクトです。

SaveContext

機能

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

プロパティ

path

保存対象のパスです。

関数プロパティ

getModel()
機能

現在開いているモデルを生成します。このモデルに保存したい内容が設定されます。

引数

なし

戻り値

保存したいモデルを返します。

FormatDocumentタイプのオブジェクトです。

info(String)
機能

ファイル読み込みに関する通知文字列を設定します。

引数
  • メッセージ

    通知したいメッセージ文字列を指定します。

戻り値

なし

warning(String)
機能

ファイル読み込みに関する警告文字列を設定します。

引数
  • メッセージ

    警告したいメッセージ文字列を指定します。

戻り値

なし

createIndeterminateProgress(String)
機能

進行率が明示できない処理であることを示し、進行率報告用オブジェクトを生成します。

引数
  • メッセージ

    処理中ダイアログに表示したいメッセージ文字列を指定します。

戻り値

進行率を管理するためのオブジェクトを返します。

Progressタイプのオブジェクトです。

createDeterminateProgress(String, int)
機能

進行率が明示できる処理であることを示し、進行率報告用オブジェクトを生成します。

引数
  • メッセージ

    処理中ダイアログに表示したいメッセージ文字列を指定します。

  • 完了までのタスク数

    完了までのタスク数を指定します。

    Progressオブジェクトの progress() を呼び出すと1タスク完了したとみなされます。

戻り値

進行率を管理するためのオブジェクトを返します。

Progressタイプのオブジェクトです。

FormatDocument

機能

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

プロパティ

rootNode

ドキュメントのルートとなるノードです。

TreeNodeタイプのオブジェクトです。

関数プロパティ

createTreeNode(String)
機能

ツリーノードを新規作成します。

引数
  • ノード文字列

    ノードに設定する文字列を指定します。

戻り値

作成されたツリーノードが返されます。

TreeNodeタイプのオブジェクトです。

Progress

機能

進行状態を示すオブジェクトです。

関数プロパティ

progress()
機能

処理の進行を通知します。

引数

なし

戻り値

なし

ThumbnailManager

機能

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

プロパティ

childNodes

現在登録されているフォーマットのリストです。読み込みのみ可能です。

ThumbnailRendererListタイプのオブジェクトです。

関数プロパティ

appendChild(renderer)
機能

マネージャにレンダラを追加します。

引数
  • 新規レンダラ

    マネージャに追加するレンダラを指定します。

    ThumbnailRendererタイプのオブジェクトを指定することができます。

戻り値

追加されたレンダラが返されます。

createRenderer(ext)
機能

指定した拡張子を持つファイルに対してサムネイルレンダリングを行うようなレンダラを生成します。

生成されたレンダラオブジェクトは、appendChildされるまで有効になりません。

引数
  • 拡張子リスト

    生成するレンダラが処理すべき拡張子のリストを指定します。

    文字列のArrayである必要があります。大文字小文字は区別されません。

戻り値

形式を示すThumbnailRendererオブジェクトが返されます。

insertBefore(newRenderer, refRenderer)
機能

マネージャの指定位置にレンダラを追加します。

引数
  • 新規レンダラ

    マネージャに追加するレンダラを指定します。

    ThumbnailRendererタイプのオブジェクトを指定することができます。

  • 追加先

    追加先を示すレンダラを指定します。

戻り値

追加されたレンダラが返されます。

removeChild(renderer)
機能

マネージャから指定されたレンダラを削除します。

引数
  • 削除するレンダラ

    削除するレンダラを指定します。

戻り値

削除されたレンダラが返されます。

ThumbnailRendererList

機能

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

プロパティ

length

リストの長さです。読み込みのみ可能です。

関数プロパティ

item(Number)
機能

ノードから要素を取得します。

Arrayと同様、[Number]によりアイテムを取得することも可能です。

引数
  • インデックス

    取得したい要素のインデックスを指定します。

戻り値

指定されたインデックスに対応する要素が返されます。

ThumbnailRendererタイプのオブジェクトです。

ThumbnailRenderer

機能

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

プロパティ

description

このレンダラの説明です。

renderCallback

このレンダラを使用してサムネイルをレンダリングする際に呼び出される関数です。

Functionタイプのオブジェクトです。第一引数にRenderContext型のオブジェクトが設定されます。

parentNode

このフォーマットを管理するマネージャです。読み込みのみ可能です。

ThumbnailManagerタイプのオブジェクトです。

関数プロパティ

accept(String)
機能

このフォーマットが指定されたパスを受け入れるかどうかを判定します。

引数
  • パス

    テストしたいパス文字列を指定します。

戻り値

この形式が指定されたパスを受け入れる場合はtrue、それ以外はfalseを返します。

ThumbnailRenderContext

機能

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

プロパティ

filename

レンダリング対象のファイル名です。

inputStream

レンダリング対象のデータです。

preferredSize

推奨レンダリングサイズです。必ずしもこのサイズに合わせて出力する必要はなく、レンダリング時の参考値として利用してください。

関数プロパティ

setBufferedImage(image)
機能

レンダリング結果を設定します。

サムネイルのレンダリング処理は、レンダリング完了後にこのメソッドを呼び出さなければなりません。

引数
  • 画像

    レンダリング結果の画像を指定します。

    このオブジェクトは、java.awt.image.BufferedImageである必要があります。

戻り値

なし

BEITELApplication

機能

BEITELアプリケーションに関する情報を表現します。

プロパティ

id

アプリケーションのID文字列です。

version

アプリケーションのバージョン文字列です。

onattach

アプリケーションの初期化が完了した際に呼び出されるイベントハンドラです。

Functionタイプのオブジェクトです。第一引数にEvent型のオブジェクトが設定されます。

ondetach

アプリケーションが停止する前に呼び出されるイベントハンドラです。

Functionタイプのオブジェクトです。第一引数にEvent型のオブジェクトが設定されます。

このハンドラ内で、Event.preventDefault()を呼び出すと、アプリケーションの停止をキャンセルすることができます。

関数プロパティ

addEventListener(String, Function)
機能

イベントリスナを登録します。

引数
  • イベント名

    イベントの名前を指定します。attach, detachのいずれかが指定可能です。

  • 関数

    イベント発生時に実行する関数を指定します。

戻り値

なし

removeEventListener(String, Function)
機能

イベントリスナの登録を解除します。

引数
  • イベント名

    イベントの名前を指定します。attach, detachのいずれかが指定可能です。

  • 関数

    イベント発生時に実行する関数を指定します。

戻り値

なし

detach(Boolean)
機能

このアプリケーションをウィンドウから切り離し、停止します。

引数
  • 全切り離しを強制するか

    全てのアプリケーション関連リソースを切り離しする場合はtrueを設定します。falseを指定すると、JavaScriptの切り離しと、必要に応じてjarの切り離しが行われます。

戻り値

切り離しが確定した場合はtrueを返します。切り離しがキャンセルされた場合はfalseを返します。

reload(Boolean)
機能

このアプリケーションのみをリロードします。

引数
  • 全リロードを強制するか

    全てのアプリケーション関連リソースをリロードする場合はtrueを設定します。falseを指定すると、JavaScriptのリロードと、必要に応じてjarのリロードが行われます。

戻り値

なし

Javaクラス

jp.carabiner.treeeditor.js.JSRunnerクラス

機能

アプリケーションの実行に必要な各種機能を提供します。

取得方法

JSRunnerオブジェクトはwindowグローバルオブジェクトから取得できます。

import jp.carabiner.treeeditor.js.JSRunner;

...

// JSRunnerオブジェクトはwindowグローバルオブジェクトから取得できます。
JSRunner runner = window.getJSRunner();

メソッド

void invokeAndWait(jp.carabiner.treeeditor.js.JSRunnable)
機能

JavaScript実行コンテキストを新規作成し、処理を実行します。

モデルに変更を加える場合は、jp.carabiner.treeeditor.js.JSRunnableインタフェースを実装し、このメソッドを通じて非同期的に実行しなければなりません。

引数
  • 実行タスク

    実行したいタスクを指定します。

    タスクは、jp.carabiner.treeeditor.js.JSRunnableインタフェースを実装する必要があります。

    タスク内では、JavaScriptコンテキストを取得することができ、jp.carabiner.treeeditor.js.JSUtilsユーティリティクラスを通じてwindowグローバルオブジェクト、documentグローバルオブジェクトを取得することが可能です。

戻り値

なし

サンプル

JSRunnableの実装例

import jp.carabiner.treeeditor.js.JSRunnable;
import jp.carabiner.treeeditor.js.JSUtils;
import jp.carabiner.treeeditor.js.JSWindow;
import jp.carabiner.treeeditor.js.JSDocument;
import org.mozilla.javascript.Context;
import org.mozilla.javascript.Scriptable;

...

public class JSSampleTask implements JSRunnable {
    public void run(Context context, Scriptable scope) {
        JSDocument document = JSUtils.getJSDocument(scope);
        JSWindow window = JSUtils.getJSWindow(scope);
        
        // 処理
        ...
    }
}

JSRunnerの取得、実行例

import jp.carabiner.treeeditor.js.JSRunner;

...

// windowグローバルオブジェクトはあらかじめ保持しておく
JSRunner runner = window.getCore().getJSRunner();
runner.invokeAndWait(new JSSampleTask());

jp.carabiner.treeeditor.js.JSRunnableインタフェース

機能

JavaScriptのタスクを表現するインタフェースです。

非同期に実行したい処理がある場合はこのインタフェースを実装し、jp.carabiner.treeeditor.js.JSRunnerを通じて実行する必要があります。

メソッド

void run(org.mozilla.javascript.Context, org.mozilla.javascript.Scriptable)
機能

タスクを実行します。

引数
  • コンテキスト

    Rhino(JavaScriptエンジン)のコンテキストです。

  • スコープ

    Rhino(JavaScriptエンジン)のスコープです。

    このオブジェクトを通じて、グローバルオブジェクトを取得することができます。

戻り値

なし

サンプル
import jp.carabiner.treeeditor.js.JSRunnable;
import jp.carabiner.treeeditor.js.JSUtils;
import jp.carabiner.treeeditor.js.JSWindow;
import jp.carabiner.treeeditor.js.JSDocument;
import org.mozilla.javascript.Context;
import org.mozilla.javascript.Scriptable;

...

public class JSSampleTask implements JSRunnable {
    public void run(Context context, Scriptable scope) {
        JSDocument document = JSUtils.getJSDocument(scope);
        JSWindow window = JSUtils.getJSWindow(scope);
        
        // 処理
        ...
    }
}

jp.carabiner.treeeditor.js.JSUtilsクラス

機能

JavaScriptの処理に関するユーティリティクラスです。

メソッド

static jp.carabiner.treeeditor.js.JSWindow getJSWindow(org.mozilla.javascript.Scriptable)
機能

スコープにひもづけられたwindowグローバルオブジェクトを取得します。

引数
  • スコープ

    Rhino(JavaScriptエンジン)のスコープです。

戻り値

windowグローバルオブジェクト。

static jp.carabiner.treeeditor.js.JSDocument getJSDocument(org.mozilla.javascript.Scriptable)
機能

スコープにひもづけられたdocumentグローバルオブジェクトを取得します。

引数
  • スコープ

    Rhino(JavaScriptエンジン)のスコープです。

戻り値

documentグローバルオブジェクト。