Eclipse Plug-in Developer Guide (Galileo) - IContext2 (Eclipse Platform API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Eclipse Platform
Release 3.5

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.help
Interface IContext2

All Superinterfaces:: IContext

All Known Subinterfaces:: IContext3

public interface IContext2
extends IContext
extends IContext

Extends IContext to provide support for styled text and topic categorization.

Since:: 3.1

Method Summary

String getCategory ( IHelpResource topic)
          Returns the category of the provided topic.

String getStyledText ()
          Returns the text description for this context with bold markers.

String getTitle ()
          Returns the optional title for this context.

Methods inherited from interface org.eclipse.help. IContext

getRelatedTopics, getText

Method Detail

getTitle


String getTitle()

Returns the optional title for this context. If the title is specified, it will be used for the presentation of this context. Otherwise, a default title will be used.

Returns:: the title to use for this context or null to use the default title.

getStyledText


String getStyledText()

Returns the text description for this context with bold markers. The markers are used to allow the UI to distinguish between bold markup and bold tags that are intended to remain part of the original text.

Returns:: String with <@#$b>and to mark bold range (as IContext.getText() used to in 2.x)

getCategory


String getCategory(
IHelpResource topic)

Returns the category of the provided topic. The category will be used in the UI to render all the topics that belong to the same category grouped together. The category string is expected to be NL-ready i.e. presentable in all NL locales.

Parameters:: topic - the topic to be categorized
Returns:: the presentable name of the category that the topic belongs to, or null if the topic belongs to the default category.