burp

インタフェース ITextEditor

public interface ITextEditor

拡張の独自のUI内でBurpのRawテキストエディタを使う場合、そのインスタンスを提供するために使用されます。拡張からIBurpExtenderCallbacks.createTextEditor()を呼び出すと、このインタフェースのインスタンスが取得できます。

メソッドのサマリー

修飾子と型	メソッドと説明
java.awt.Component	getComponent() 拡張が独自のUIを追加するための、エディタのUIコンポーネントを返します。
byte[]	getSelectedText() 現在選択されているテキストを取得します。
int[]	getSelectionBounds() 該当する場合、表示されているテキストにおけるユーザの選択範囲を取得します。
byte[]	getText() 現在表示されているテキストを取得します。
boolean	isTextModified() ユーザがエディタの内容を変更したかどうかを判別します。
void	setEditable(boolean editable) エディタが現在編集可能かどうかを制御します。
void	setSearchExpression(java.lang.String expression) エディタの下の検索バーに表示される検索式を更新します。
void	setText(byte[] text) エディタに現在表示されているテキストを更新します。

メソッドの詳細

getComponent

java.awt.Component getComponent()

拡張が独自のUIを追加するための、エディタのUIコンポーネントを返します。

戻り値:

エディタのUIコンポーネント。

setEditable

void setEditable(boolean editable)

エディタが現在編集可能かどうかを制御します。このステータスは、必要に応じてオンとオフを切り替えられます。

パラメータ:

editable - エディタが現在編集可能かどうかを示すフラグ。

setText

void setText(byte[] text)

エディタに現在表示されているテキストを更新します。

パラメータ:

text - 表示するテキスト。

getText

byte[] getText()

現在表示されているテキストを取得します。

戻り値:

現在表示されているテキスト。

isTextModified

boolean isTextModified()

ユーザがエディタの内容を変更したかどうかを判別します。

戻り値:

最後にsetText()が呼ばれた後、ユーザがエディタの内容を変更したかどうか。

getSelectedText

byte[] getSelectedText()

現在選択されているテキストを取得します。

戻り値:

現在選択されているテキスト、またはユーザが何も選択していない場合はnull。

getSelectionBounds

int[] getSelectionBounds()

該当する場合、表示されているテキストにおけるユーザの選択範囲を取得します。

戻り値:

表示されたテキストでユーザが選択した、開始と終了オフセットを含んだint[2]配列。ユーザが現在のメッセージで選択をしていない場合は、両方のオフセットはエディタ内のキャレットの位置を示します。

setSearchExpression

void setSearchExpression(java.lang.String expression)

エディタの下の検索バーに表示される検索式を更新します。検索式に一致するテキストの領域を、エディタは自動的に強調表示します。

パラメータ:

expression - 検索式。