com.togethersoft.openapi.ide.inspector.util
Class DocComponent

java.lang.Object
  |
  +--java.beans.FeatureDescriptor
        |
        +--com.togethersoft.openapi.ide.inspector.IdeInspectorComponent
              |
              +--com.togethersoft.openapi.ide.inspector.util.DocComponent

public class DocComponent
extends IdeInspectorComponent
implements UIComponentService

This class represents inspector component suited to show javadoc for selected RwiElement. This component appears as a
"Doc" tab in the inspector.

Author:
TogetherSoft
Since: Together 4.0

Field Summary
 private final static StringHTML_ERROR_MESSAGE
           
 private JEditorPanemyEditorPane
           
 private StringmyHTMLString
           
 private RwiElementmyRwiElement
           
 private JScrollPanemyScrollPane
           
 final static StringNAME
          This property presents tab title for this inspector component.

Constructor Summary
DocComponent(RwiElement element)
          Constructs DocComponent for certain RwiElement.

Method Summary
 ComponentgetUIComponent()
          Returns Swing component which represents this inspector component.
 voidupdate()
          Updates view of this component.

Methods inherited from class com.togethersoft.openapi.ide.inspector.IdeInspectorComponent
getService, setService

Methods inherited from class java.beans.FeatureDescriptor
getName, setName, getDisplayName, setDisplayName, isExpert, setExpert, isHidden, setHidden, isPreferred, setPreferred, getShortDescription, setShortDescription, setValue, getValue, attributeNames

Methods inherited from class java.lang.Object
getClass, hashCode, equals, clone, toString, notify, notifyAll, wait, wait, wait, finalize

Field Detail

HTML_ERROR_MESSAGE

private final static String HTML_ERROR_MESSAGE

myEditorPane

private JEditorPane myEditorPane

myHTMLString

private String myHTMLString

myRwiElement

private RwiElement myRwiElement

myScrollPane

private JScrollPane myScrollPane

NAME

public final static String NAME
This property presents tab title for this inspector component.
Constructor Detail

DocComponent

public DocComponent(RwiElement element)
Constructs DocComponent for certain RwiElement.
Parameters:
element Selected RwiElement
Method Detail

getUIComponent

public Component getUIComponent()
Returns Swing component which represents this inspector component.
Returns: Swing component which represents this inspector component

update

public void update()
Updates view of this component. Called whenever docs are changed in the "Javadoc" tab.

Association Links

to Class java.lang.String

This property presents tab title for this inspector component.

to Class com.togethersoft.openapi.rwi.RwiElement

to Class java.lang.String

to Class javax.swing.JScrollPane

to Class javax.swing.JEditorPane

to Class java.lang.String