IDocumentSection

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> org >> eclipse >> pde >> internal >> core >> [ ischema overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of org.eclipse.pde.internal.core.ischema.IDocumentSection

SOURCE |

Download org.eclipse.pde.internal.core.ischema.IDocumentSection

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.pde.internal.core.ischema
Interface IDocumentSection

All Superinterfaces:: org.eclipse.core.runtime.IAdaptable, ISchemaObject, org.eclipse.pde.core.IWritable

public interface IDocumentSection
extends ISchemaObject

Document section is portion of the extension point schema definition that will be taken and built into the final reference HTML document. There are several predefined document sections that PDE recognizes:

MARKUP - will be used for "Markup" section
EXAMPLES - will be used for "Examples" section
API_INFO - will be used for "API information" section
IMPLEMENTATION - will be used for "Supplied Implementation" section

Text that objects of this class carry can contain HTML tags that will be copied into the target document as-is.

Field Summary

static java.lang.String API_INFO
          Section Id for the "API Information" section of the target reference document

static java.lang.String COPYRIGHT
          Section Id for the copyright statement section of the target reference document

static java.lang.String EXAMPLES
          Section Id for the "Examples" section of the target reference document

static java.lang.String IMPLEMENTATION
          Section Id for the "Supplied Implementation" section of the target reference document

static java.lang.String MARKUP
          Section Id for the "Markup" section of the target reference document

static java.lang.String SINCE
          Section Id for the first version in which the extension point appears.

Fields inherited from interface org.eclipse.pde.internal.core.ischema.ISchemaObject

P_DESCRIPTION, P_NAME

Method Summary

java.lang.String getSectionId()
          Returns the Id of this section.

Methods inherited from interface org.eclipse.pde.internal.core.ischema.ISchemaObject

getDescription, getName, getParent, getSchema, setParent

Methods inherited from interface org.eclipse.core.runtime.IAdaptable

getAdapter

Methods inherited from interface org.eclipse.pde.core.IWritable

write

Field Detail

MARKUP

public static final java.lang.String MARKUP

Section Id for the "Markup" section of the target reference document

See Also:: Constant Field Values

EXAMPLES

public static final java.lang.String EXAMPLES

Section Id for the "Examples" section of the target reference document

See Also:: Constant Field Values

IMPLEMENTATION

public static final java.lang.String IMPLEMENTATION

Section Id for the "Supplied Implementation" section of the target reference document

See Also:: Constant Field Values

API_INFO

public static final java.lang.String API_INFO

Section Id for the "API Information" section of the target reference document

See Also:: Constant Field Values

COPYRIGHT

public static final java.lang.String COPYRIGHT

Section Id for the copyright statement section of the target reference document

See Also:: Constant Field Values

SINCE

public static final java.lang.String SINCE

Section Id for the first version in which the extension point appears.

See Also:: Constant Field Values

Method Detail

getSectionId

public java.lang.String getSectionId()

Returns the Id of this section.