プロパティ (Properties)
rootItem
レイアウト階層内の最上位 ContentItem(通常は RowOrColumn、Stack、または ComponentItem)。
container
レイアウトをホストしているネイティブ HTMLElement DOM コンテナへの参照。
isInitialised
レイアウトインスタンスの初期化が完了し、initialised イベントが発行された後に true。
isDestroyed
レイアウトが破棄された場合に true。
layoutConfig
解決済みの設定、寸法、アイテムツリーを表す現在の ResolvedLayoutConfig への読み取り専用参照。
状態を永続化したり、復元用に設定をエクスポートするには、layout.saveLayout()
を呼び出します。
focusedComponentItem
現在フォーカスされている ComponentItem、またはフォーカスがない場合は undefined。
width
レイアウトの外側の現在の幅(ピクセル単位、未描画時は null)。
height
レイアウトの外側の現在の高さ(ピクセル単位、未描画時は null)。
openPopouts
このレイアウトによって管理されているアクティブな BrowserPopout ウィンドウインスタンスの配列。
isSubWindow
このレイアウトインスタンスが別のレイアウトによってポップアウト子ウィンドウとして生成された場合に true。
eventHub
すべてのアイテムおよびポップアウトウィンドウ間でメッセージを中継するネイティブの EventHub インスタンス。
イベント (Events)
initialised
レイアウトが初期化され、最初のDOM描画が完了したときに発行されます。
stateChanged
ペインのサイズ変更、タブの移動、アイテムの追加/削除など、レイアウト状態が変更されたときに発行されます。
windowOpened
ポップアウトウィンドウが作成されたときに発行されます。
windowClosed
ポップアウトウィンドウが閉じられたときに発行されます。
focus
コンポーネントまたはアイテムがフォーカスを受け取ったときに発行されます。
blur
コンポーネントまたはアイテムがフォーカスを失ったときに発行されます。
activeContentItemChanged
スタック内でアクティブなタブ/コンテンツアイテムが切り替わったときに発行されます。
beforeComponentRelease
コンポーネントアイテムが解放またはアンマウントされる直前に発行されます。
itemCreated
レイアウトツリーに新しいアイテムが作成されたときに発行されます。
itemDestroyed
アイテムがレイアウトツリーから破棄されたときに発行されます。
componentCreated
新しいコンポーネントアイテムがインスタンス化されたときに発行されます。
メソッド (Methods)
StrelitLayout( container?, bindComponentEventHandler?, unbindComponentEventHandler? )
レイアウトマネージャーの新しいインスタンスを構築します。
import { StrelitLayout } from 'strelit-ui-kit';
const container = document.getElementById('layoutContainer');
const layout = new StrelitLayout(container);
init()
レイアウトマネージャーを初期化します。loadLayout() を呼び出すと自動的に実行されます。
loadLayout( layoutConfig )
宣言的設定オブジェクトを読み込み、コンテナ内に完全なレイアウトツリーを構築します。
layout.loadLayout({
root: {
type: 'row',
content: [
{ type: 'component', componentType: 'viewer', title: 'Preview' },
{ type: 'component', componentType: 'editor', title: 'Code Editor' },
],
},
});
saveLayout()
現在のワークスペース(アクティブなタブ、スプリッターの寸法、コンポーネントの状態)を JSON シリアライズ可能な ResolvedLayoutConfig オブジェクトとして出力します。
const savedState = layout.saveLayout();
localStorage.setItem('workspaceConfig', JSON.stringify(savedState));
registerComponentFactoryFunction( typeName, componentFactoryFunction, virtual? )
指定された typeName のコンポーネントファクトリ関数を登録します。
layout.registerComponentFactoryFunction('viewer', (container, itemConfig) => {
container.element.innerHTML = '<div class="p-4"><h3>ビューアコンテンツ</h3></div>';
});
registerComponentConstructor( typeName, componentConstructor, virtual? )
クラスベースのコンポーネントコンストラクタを登録します。
setSize( width, height )
レイアウト全体の幅と高さを指定されたピクセル値に明示的に設定し、内部のすべてのペインを再計算します。
layout.setSize(1280, 720);
updateRootSize( force? )
外側の DOM コンテナ要素の寸法を測定し、レイアウトツリーを自動的に更新します。ウィンドウのリサイズイベントハンドラーで呼び出すのに適しています。
window.addEventListener('resize', () => {
layout.updateRootSize();
});
newComponent( componentType, componentState?, title? )
新しいコンポーネントアイテムインスタンスを作成して返します。
addComponent( componentType, componentState?, title? )
新しいコンポーネントをレイアウトに直接追加します。
newDragSource( element, itemConfigCallback )
指定された HTML 要素を外部ドラッグソースとして登録し、ユーザーが要素をレイアウトツリー内に直接ドラッグ&ドロップできるようにします。
focusComponent( item, suppressEvent? )
指定されたコンポーネントアイテムにフォーカスを当てます。
createPopout( itemConfigOrContentItem, positionAndSize, parentId?, indexInParent? )
特定のアイテムをプログラムから独立したポップアウトウィンドウへ切り離します。
closeAllOpenPopouts()
現在開いているすべてのポップアウトウィンドウを閉じます。
clear()
現在描画されているすべてのアイテムを削除してレイアウトを空にします。
destroy()
すべてのイベントリスナーを解除し、DOM 要素をクリーンアップしてレイアウトインスタンスを破棄します。