javax.swing.text.html
클래스 HTMLEditorKit

java.lang.Object 
  |
  +--javax.swing.text.EditorKit 
        |
        +--javax.swing.text.DefaultEditorKit 
              |
              +--javax.swing.text.StyledEditorKit 
                    |
                    +--javax.swing.text.html.HTMLEditorKit

모든 구현 인터페이스:

Accessible , Cloneable , Serializable

public class HTMLEditorKit

extends StyledEditorKit

implements Accessible

Swing 의 JEditorPane 텍스트 컴퍼넌트는 EditorKit 로 불리는 플러그 인 기구에 의해, 다양한 종류의 컨텐츠를 서포트하고 있습니다. HTML 는 매우 일반적인 형식이므로, 부분적인 서포트를 디폴트로 제공하고 있습니다. 이 클래스가 제공하는 디폴트의 서포트는 HTML 3.2 (일부의 확장을 포함한다)를 서포트하고 있어, 현재 4.0 의 서포트를 향해 이행중입니다. 현재 <applet> 태그는 서포트되고 있지 않습니다만, <object> 태그의 일부분은 서포트되고 있습니다.

HTML EditorKit 는 몇개의 목표를 가져 제공되고 있어 이것은 HTML 를 모델화하는 수법으로 반영되고 있습니다. 그러한 목표가, 클래스의 설계에 실질적인 영향을 주고 있습니다.

편집의 서포트

JEditorPane 를 위한 플러그 인이, 편집을 서포트 해야 한다고 말하는 것은 명백합니다만, 편집을 서포트하려면 설계상의 고려해야 할 문제가 몇개인가 있습니다. HTML 의 규격에 완전하게는 준거하지 않는 HTML 문서가 많이 나돌고 있다고 하는 사실이 있습니다. 이러한 문서를 편집하려면 , 하등의 방법으로 올바른 형식에 정규화할 필요가 있습니다. 게다가 유저는 다량의 구조 편집을 좋아하지 않는다고 하는 사실이 있습니다. 이 때문에, HTML 문서로 정의되고 있는 대로의 HTML 구조는 아니고, 종래의 텍스트 편집의 조작이 선호됩니다.

HTML 의 모델화는 HTMLDocument 클래스에서 제공되고 있습니다. HTML 의 모델화에 대해서는 HTMLDocument 클래스의 설명을 참조해 주세요. 편집의 서포트는 주로 text 패키지로 제공됩니다.

확장 가능/스케이라불

이 킷을 낭비 없게 활용할 수 있게 하기 위해서, 킷을 확장 가능하게 하는 노력이 지불해지고 있습니다. 다음에 그 내용의 일부를 나타냅니다.

1. 파서는 옮겨놓고 가능합니다. 디폴트의 파서는 DTD 에 근거한 HotJava 파서입니다. 다른 DTD 를 사용하거나 완전히 별개의 파서를 사용할 수도 있습니다. 파서를 변경하려면 , getParser 메소드를 다시 구현해 주세요. 디폴트의 파서는 최초의 요구가 있었을 때에 동적으로 로드 되기 (위해)때문에, 다른 파서를 사용하는 경우는 로드 되지 않습니다. 디폴트의 파서는 이 패키지와는 독립에, 하위의 parser 패키지에 있습니다.
2. 파서는 HTMLDocument 에 의해 제공되는 PaserCallback 를 작동시킵니다. 콜백을 변경하려면 , HTMLDocument 를 서브 클래스화해, 다른 리더를 생성하는 문서를 돌려주도록(듯이) createDefaultDocument 메소드를 다시 구현해 주세요. 리더는 문서가 어떻게 구조화 되는지를 제어합니다. Document 는 디폴트에서는 HTML 서포트를 제공합니다만, HTML 이외의 태그에 의해 다른 요소 구조를 서포트하는 일도 가능합니다.
3. 그 모델의 디폴트의 뷰는 View 구현의 계층으로서 제공되기 때문에, 특정의 요소의 표시 방법을 커스터마이즈 하거나 새로운 View 의 구현을 제공하는 것으로, 새로운 종류의 요소에 대한 기능을 용이하게 추가할 수 있습니다. 디폴트의 뷰세트는 HTMLFactory 클래스에 의해 제공됩니다. 뷰세트를 변경하려면 , HTMLFactory 를 서브 클래스화 또는 옮겨놓은 다음, getViewFactory 메소드를 다시 구현해 다른 팩토리를 돌려주도록(듯이) 합니다.
4. View 의 구현은 주로, 뷰내에 보관 유지되고 있는 CSS 속성을 사용해 기능합니다. 이것에 의해, 실질적으로 달라 보이는 같은 모델에 복수의 뷰를 매핑 하는 것이 가능하게 됩니다. 이것은 출력 시에 특히 편리합니다. HTML 속성이 많게 관계해서는 표시용으로 HTML 속성이 CSS 속성에 변환됩니다. 이것은 View 의 구현을 범용적으로 하는데 도움이 됩니다.

비동기 로드

큰 문서에서는 대량의 해석이 필요하게 되어 로드에 다소 시간이 걸립니다. 디폴트에서는 이 킷은 JEditorPane.setPage 를 사용해 로드하는 경우에 비동기에 로드 되는 문서를 작성합니다. 이것은 문서의 프로퍼티에 의해 제어됩니다. createDefaultDocument 메소드를 오버라이드(override) 하면, 프로퍼티를 변경할 수 있습니다. 작업의 배치는 HTMLDocument.HTMLReader 클래스가 실시해, 실제의 작업은 text 패키지의 DefaultStyledDocument 및 AbstractDocument 클래스가 실시합니다.

현재의 Look & Feel 로부터의 커스터마이즈

HTML 는 잘 알려진 표시 기능을 제공합니다만, 그 표시 특성은 정확하게는 지정되고 있지 않습니다. Swing 는 Look & Feel 의 구현에 테마 기구를 가지고 있습니다. 이 Look & Feel 가, HTML 뷰에 표시 특성을 주게 되어 있으면 편리합니다. 예를 들어, 시력의 약한 사람이, 통상보다 콘트라스트가 강하게 사이즈의 큰 폰트를 사용할 수 있게 됩니다.

이 기능은 StyleSheet 클래스에 의해 제공됩니다. HTML 의 표현은 EditorKit 의 StyleSheet 프로퍼티의 설정에 의해, 자유롭게 바꿀 수가 있습니다.

데이터의 손실 없음

EditorKit 는 문서를 읽어들여 보존하는 능력을 가지고 있습니다. 일반적으로 유저에게 있어서는 read와 보존의 조작동안에 데이터의 손실이 없는 것이 바람직합니다. HTMLEditorKit 의 폴리시는 인식할 수 없었던 것이나 표시되지 않는 것도 나중에 써낼 때를 위해서(때문에) 메모리에 보존해 두는 것입니다. 따라서, HTML 문서의 모델에서는 통상, 문서의 read중에 검출된 정보는 모두 저장됩니다. 그러나, 이 폴리시는 편집을 서포트하기 위해서 어떤 종류의 제약을 받습니다 (부정확한 문서를 정규화해야 하는 경우 등). 결국, 가이드 라인이 되는 원칙은 「정보는 없어지지 않게, 그러나, 보다 정확한 모델을 작성하기 위해서, 부분적인 합성이나 늘어놓고 대체는 있을 수 있다」라고 하게 됩니다.

중첩된 클래스의 개요

static class	HTMLEditorKit.HTMLFactory HTML 용의 뷰를 작성하는 팩토리입니다.
static class	HTMLEditorKit.HTMLTextAction HTML 를 기존의 문서에 삽입하는데 편리한 간이 메소드를 제공하는 abstract Action 입니다.
static class	HTMLEditorKit.InsertHTMLTextAction InsertHTMLTextAction 는 기존의 HTML 문서에 임의의 HTML 캐릭터 라인을 삽입하기 위해서 사용합니다.
static class	HTMLEditorKit.LinkController 관련하는 컴퍼넌트를 감시해, 필요에 따라서 하이퍼 링크 이벤트를 발생시키는 클래스입니다.
static class	HTMLEditorKit.Parser 파서가 서포트하는 인터페이스입니다.
static class	HTMLEditorKit.ParserCallback 구문 분석의 결과가, 이러한 콜백 메소드를 호출합니다.

클래스 javax.swing.text. StyledEditorKit 을 상속받은 중첩된 클래스

StyledEditorKit.AlignmentAction , StyledEditorKit.BoldAction , StyledEditorKit.FontFamilyAction , StyledEditorKit.FontSizeAction , StyledEditorKit.ForegroundAction , StyledEditorKit.ItalicAction , StyledEditorKit.UnderlineAction

클래스 javax.swing.text. DefaultEditorKit 을 상속받은 중첩된 클래스

DefaultEditorKit.BeepAction , DefaultEditorKit.CopyAction , DefaultEditorKit.CutAction , DefaultEditorKit.DefaultKeyTypedAction , DefaultEditorKit.InsertBreakAction , DefaultEditorKit.InsertContentAction , DefaultEditorKit.InsertTabAction , DefaultEditorKit.PasteAction

필드의 개요

static String	BOLD_ACTION 볼드 처리 식별자입니다.
static String	COLOR_ACTION 색선택 처리 식별자입니다.
static String	DEFAULT_CSS 태그 표시를 설정하는 디폴트의 CSS (Cascading Style Sheet) 파일입니다.
static String	FONT_CHANGE_BIGGER 다음 사이즈에의 폰트 확대 식별자입니다.
static String	FONT_CHANGE_SMALLER 다음 사이즈에의 폰트 축소 식별자입니다.
static String	IMG_ALIGN_BOTTOM 하단에 이미지를 정렬시킵니다.
static String	IMG_ALIGN_MIDDLE 중앙에 이미지를 정렬시킵니다.
static String	IMG_ALIGN_TOP 상단에 이미지를 정렬시킵니다.
static String	IMG_BORDER 경계에 이미지를 정렬시킵니다.
static String	ITALIC_ACTION 이탤릭 처리 식별자입니다.
static String	LOGICAL_STYLE_ACTION 논리 스타일 선택 처리 식별자입니다.
static String	PARA_INDENT_LEFT 단락의 왼쪽 인덴트 처리 식별자입니다.
static String	PARA_INDENT_RIGHT 단락의 오른쪽 인덴트 처리 식별자입니다.

클래스 javax.swing.text. DefaultEditorKit 에서 상속받은 필드

backwardAction , beepAction , beginAction , beginLineAction , beginParagraphAction , beginWordAction , copyAction , cutAction , defaultKeyTypedAction , deleteNextCharAction , deletePrevCharAction , downAction , endAction , endLineAction , EndOfLineStringProperty , endParagraphAction , endWordAction , forwardAction , insertBreakAction , insertContentAction , insertTabAction , nextWordAction , pageDownAction , pageUpAction , pasteAction , previousWordAction , readOnlyAction , selectAllAction , selectionBackwardAction , selectionBeginAction , selectionBeginLineAction , selectionBeginParagraphAction , selectionBeginWordAction , selectionDownAction , selectionEndAction , selectionEndLineAction , selectionEndParagraphAction , selectionEndWordAction , selectionForwardAction , selectionNextWordAction , selectionPreviousWordAction , selectionUpAction , selectLineAction , selectParagraphAction , selectWordAction , upAction , writableAction

생성자의 개요

HTMLEditorKit ()
HTMLEditorKit 를 구축해, StyleContext 를 작성해, 스타일 시트를 로드합니다.

메소드의 개요

Object	clone () 편집 킷의 카피를 작성합니다.
Document	createDefaultDocument () 이 타입의 에디터에 적절한 초기화되지 않는 텍스트 저장 모델을 작성합니다.
protected void	createInputAttributes (Element element, MutableAttributeSet set) element 의 AttributeSet 내의 키와 값의 페어를 set 에 카피합니다.
void	deinstall (JEditorPane c) 킷이 JEditorPane 로부터 삭제되고 있을 때 불려 갑니다.
AccessibleContext	getAccessibleContext () 이 편집 킷에 관련한 AccessibleContext 를 돌려줍니다.
Action []	getActions () 에디터의 커멘드 리스트를 꺼냅니다.
String	getContentType () 이 킷이 서포트하는 MIME 타입의 데이터를 돌려줍니다.
Cursor	getDefaultCursor () 디폴트의 커서를 돌려줍니다.
MutableAttributeSet	getInputAttributes () 서식 첨부 편집 액션에 사용되는 입력 속성을 돌려줍니다.
Cursor	getLinkCursor () 하이퍼 링크상에서 사용하는 커서를 설정합니다.
protected HTMLEditorKit.Parser	getParser () HTML 스트림의 읽어들여에 사용하는 파서를 꺼냅니다.
StyleSheet	getStyleSheet () HTML 요소의 표현에 사용되고 있는 스타일 세트를 돌려줍니다.
ViewFactory	getViewFactory () 이 킷으로 작성되는 모델의 뷰의 생성에 적절한 팩토리를 꺼냅니다.
void	insertHTML (HTMLDocument doc, int offset, String html, int popDepth, int pushDepth, HTML.Tag insertTag) 기존의 문서에 HTML 를 삽입합니다.
void	install (JEditorPane c) 킷이 JEditorPane 에 인스톨 될 때 불려 갑니다.
void	read (Reader in, Document doc, int pos) 지정된 스트림으로부터 컨텐츠를 삽입합니다.
void	setDefaultCursor (Cursor cursor) 디폴트의 커서를 설정합니다.
void	setLinkCursor (Cursor cursor) 링크상에서 사용하는 커서를 설정합니다.
void	setStyleSheet (StyleSheet s) 각종의 HTML 요소의 표현에 사용되는 스타일 세트를 설정합니다.
void	write (Writer out, Document doc, int pos, int len) 이 타입의 컨텐츠 핸들러에 적합한 서식인 것이 요구되는 스트림에, 문서의 컨텐츠를 적합한 형식에서 스트림에 삽입합니다.

클래스 javax.swing.text. StyledEditorKit 에서 상속받은 메소드

getCharacterAttributeRun

클래스 javax.swing.text. DefaultEditorKit 에서 상속받은 메소드

createCaret , read , write

클래스 java.lang. Object 에서 상속받은 메소드

equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait

필드의 상세

DEFAULT_CSS

public static final String  DEFAULT_CSS

태그 표시를 설정하는 디폴트의 CSS (Cascading Style Sheet) 파일입니다.

관련 항목:

정수 필드치

BOLD_ACTION

public static final String  BOLD_ACTION

볼드 처리 식별자입니다.

관련 항목:

정수 필드치

ITALIC_ACTION

public static final String  ITALIC_ACTION

이탤릭 처리 식별자입니다.

관련 항목:

정수 필드치

PARA_INDENT_LEFT

public static final String  PARA_INDENT_LEFT

단락의 왼쪽 인덴트 처리 식별자입니다.

관련 항목:

정수 필드치

PARA_INDENT_RIGHT

public static final String  PARA_INDENT_RIGHT

단락의 오른쪽 인덴트 처리 식별자입니다.

관련 항목:

정수 필드치

FONT_CHANGE_BIGGER

public static final String  FONT_CHANGE_BIGGER

다음 사이즈에의 폰트 확대 식별자입니다.

관련 항목:

정수 필드치

FONT_CHANGE_SMALLER

public static final String  FONT_CHANGE_SMALLER

다음 사이즈에의 폰트 축소 식별자입니다.

관련 항목:

정수 필드치

COLOR_ACTION

public static final String  COLOR_ACTION

색선택 처리 식별자입니다. 색은 인수로 건네줍니다.

관련 항목:

정수 필드치

LOGICAL_STYLE_ACTION

public static final String  LOGICAL_STYLE_ACTION

논리 스타일 선택 처리 식별자입니다. 논리 스타일은 인수로 건네줍니다.

관련 항목:

정수 필드치

IMG_ALIGN_TOP

public static final String  IMG_ALIGN_TOP

상단에 이미지를 정렬시킵니다.

관련 항목:

정수 필드치

IMG_ALIGN_MIDDLE

public static final String  IMG_ALIGN_MIDDLE

중앙에 이미지를 정렬시킵니다.

관련 항목:

정수 필드치

IMG_ALIGN_BOTTOM

public static final String  IMG_ALIGN_BOTTOM

하단에 이미지를 정렬시킵니다.

관련 항목:

정수 필드치

IMG_BORDER

public static final String  IMG_BORDER

경계에 이미지를 정렬시킵니다.

관련 항목:

정수 필드치

생성자의 상세

HTMLEditorKit

public HTMLEditorKit()

HTMLEditorKit 를 구축해, StyleContext 를 작성해, 스타일 시트를 로드합니다.

메소드의 상세

getContentType

public String  getContentType()

이 킷이 서포트하는 MIME 타입의 데이터를 돌려줍니다. 이 킷은 text/html 의 타입을 서포트합니다.

오버라이드(override):

클래스 DefaultEditorKit 내의 getContentType

반환값:

타입

getViewFactory

public ViewFactory  getViewFactory()

이 킷으로 작성되는 모델의 뷰의 생성에 적절한 팩토리를 꺼냅니다.

오버라이드(override):

클래스 StyledEditorKit 내의 getViewFactory

반환값:

팩토리

createDefaultDocument

public Document  createDefaultDocument()

이 타입의 에디터에 적절한 초기화되지 않는 텍스트 저장 모델을 작성합니다.

오버라이드(override):

클래스 StyledEditorKit 내의 createDefaultDocument

반환값:

모델

read

public void read(Reader  in,
                 Document  doc,
                 int pos)
          throws IOException ,
                 BadLocationException 

지정된 스트림으로부터 컨텐츠를 삽입합니다. doc 가 HTMLDocument 의 인스턴스인 경우, HTML 3.2 텍스트를 읽어들입니다. 하늘이 아닌 문서에의 HTML 의 삽입은 본체 요소 내부에서 실시할 필요가 있습니다. 본체에 삽입하지 않는 경우, 예외가 슬로우 됩니다. 하늘이 아닌 문서에 삽입하는 경우, 본체 외부의 태그 (헤드, 타이틀)는 모두 삭제됩니다.

오버라이드(override):

클래스 DefaultEditorKit 내의 read

파라미터:

in - read원의 스트림

doc - 삽입처

pos - 컨텐츠를 배치하는 문서내의 위치

예외:

IOException - 입출력 에러가 발생했을 경우

BadLocationException - pos 가 문서내의 무효인 위치를 나타내는 경우

RuntimeException - pos 가 무효인 경우 (결과적으로 BadLocationException 가 된다)

insertHTML

public void insertHTML(HTMLDocument  doc,
                       int offset,
                       String  html,
                       int popDepth,
                       int pushDepth,
                       HTML.Tag  insertTag)
                throws BadLocationException ,
                       IOException 

기존의 문서에 HTML 를 삽입합니다.

파라미터:

doc - 삽입처의 문서

offset - HTML 의 삽입 위치의 오프셋(offset)

popDepth - 삽입전에 생성되는 ElementSpec.EndTagType 태그의 수

pushDepth - 종료 태그의 생성 후, 삽입전에 생성되는 ElementSpec.JoinNextDirection 의 방향을 가지는 ElementSpec.StartTagType 의 태그의 수

insertTag - 문서에의 삽입을 개시하는 최초의 태그

예외:

RuntimeException - pos 가 무효인 경우 (결과적으로 BadLocationException 가 된다)

BadLocationException

IOException

write

public void write(Writer  out,
                  Document  doc,
                  int pos,
                  int len)
           throws IOException ,
                  BadLocationException 

이 타입의 컨텐츠 핸들러에 적합한 서식인 것이 요구되는 스트림에, 문서의 컨텐츠를 적합한 형식에서 스트림에 삽입합니다.

오버라이드(override):

클래스 DefaultEditorKit 내의 write

파라미터:

out - 기입처의 스트림

doc - 기입원

pos - 컨텐츠를 취득하는 문서내의 위치

len - 써내는 양

예외:

IOException - 입출력 에러가 발생했을 경우

BadLocationException - pos 가 문서내의 무효인 위치를 나타내는 경우

install

public void install(JEditorPane  c)

킷이 JEditorPane 에 인스톨 될 때 불려 갑니다.

오버라이드(override):

클래스 StyledEditorKit 내의 install

파라미터:

c - JEditorPane

deinstall

public void deinstall(JEditorPane  c)

킷이 JEditorPane 로부터 삭제되고 있을 때 불려 갑니다. 이 메소드는 추가된 청취자의 등록을 해제하기 위해서 사용됩니다.

오버라이드(override):

클래스 StyledEditorKit 내의 deinstall

파라미터:

c - JEditorPane

setStyleSheet

public void setStyleSheet(StyleSheet  s)

각종의 HTML 요소의 표현에 사용되는 스타일 세트를 설정합니다. 이러한 스타일은 CSS 사양에 근거해 지정됩니다. 킷으로 작성되는 각 문서에는 문서 전용의 스타일을 등록할 수 있는 시트의 카피가 첨부됩니다. 디폴트에서는 지정되는 StyleSheet 는 모든 HTMLEditorKit 의 인스턴스가 공유합니다. 필요에 따라서, 이 메소드를 다시 구현해 보다 상세한 설정을 실시합니다.

getStyleSheet

public StyleSheet  getStyleSheet()

HTML 요소의 표현에 사용되고 있는 스타일 세트를 돌려줍니다. 디폴트에서는 DEFAULT_CSS 로 지정되는 리소스가 로드 되어 모든 HTMLEditorKit 의 인스턴스로 공유됩니다.

getActions

public Action [] getActions()

에디터의 커멘드 리스트를 꺼냅니다. 이것은 서식 처리를 위해서(때문에) 로컬로 정의된 커멘드의 콜렉션에 의해 추가된 슈퍼 클래스에 의해 서포트되는 커멘드의 리스트입니다.

오버라이드(override):

클래스 StyledEditorKit 내의 getActions

반환값:

커멘드 리스트

createInputAttributes

protected void createInputAttributes(Element  element,
                                     MutableAttributeSet  set)

element 의 AttributeSet 내의 키와 값의 페어를 set 에 카피합니다. 이 메소드는 컴퍼넌트, 아이콘, 요소명의 각 속성은 카피하지 않습니다. 서브 클래스에서는 어느 속성을 카피해 어느 속성을 카피하지 않는가를 변경할 수도 있습니다. 다만, 최초로 set 내의 모든 속성을 반드시 삭제해 주세요.

이 메소드는 caret가 다른 위치로 이동할 때마다 불려 갑니다.

오버라이드(override):

클래스 StyledEditorKit 내의 createInputAttributes

getInputAttributes

public MutableAttributeSet  getInputAttributes()

서식 첨부 편집 액션에 사용되는 입력 속성을 돌려줍니다.

오버라이드(override):

클래스 StyledEditorKit 내의 getInputAttributes

반환값:

속성 세트

setDefaultCursor

public void setDefaultCursor(Cursor  cursor)

디폴트의 커서를 설정합니다.

도입된 버젼:

1.3

getDefaultCursor

public Cursor  getDefaultCursor()

디폴트의 커서를 돌려줍니다.

도입된 버젼:

1.3

setLinkCursor

public void setLinkCursor(Cursor  cursor)

링크상에서 사용하는 커서를 설정합니다.

도입된 버젼:

1.3

getLinkCursor

public Cursor  getLinkCursor()

하이퍼 링크상에서 사용하는 커서를 설정합니다.

clone

public Object  clone()

편집 킷의 카피를 작성합니다.

오버라이드(override):

클래스 StyledEditorKit 내의 clone

반환값:

카피

getParser

protected HTMLEditorKit.Parser  getParser()

HTML 스트림의 읽어들여에 사용하는 파서를 꺼냅니다. 이 메소드를 다시 구현해 다른 파서를 제공할 수가 있습니다. 디폴트의 구현은 동적으로 로드 됩니다. 이것은 디폴트의 구현이 사용되지 않는 경우의, 디폴트의 파서의 로드에 의한 오버헤드를 피하기 (위해)때문에입니다. 디폴트의 파서는 HTML 3.2 DTD 를 사용하는 HotJava 입니다.

getAccessibleContext

public AccessibleContext  getAccessibleContext()

이 편집 킷에 관련한 AccessibleContext 를 돌려줍니다.

정의:

인터페이스 Accessible 내의 getAccessibleContext

반환값:

이 편집 킷에 관련한 AccessibleContext

도입된 버젼:

1.4