org.eclipse.ui.help
Class DialogPageContextComputer
java.lang.Object
org.eclipse.ui.help.DialogPageContextComputer
-
All Implemented Interfaces:
-
IContextComputer
Deprecated. nested contexts are no longer supported by the help support system
-
public class DialogPageContextComputer
- extends
Object
- implements
IContextComputer
For determining the help context for controls in a dialog page.
This class may be instantiated; it is not intended to be subclassed.
-
Restriction:
- This class is not intended to be subclassed by clients.
Methods inherited from class java.lang.
Object
|
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait
|
DialogPageContextComputer
public DialogPageContextComputer(
IDialogPage page,
Object helpContext)
-
Deprecated.
- Creates a new context computer for the given dialog page and help context.
-
Parameters:
-
page
- the dialog page -
helpContext
- a single help context id (type String
) or
help context object (type IContext
)
computeContexts
public
Object[] computeContexts(
HelpEvent event)
-
Deprecated.
-
Description copied from interface:
IContextComputer
- Computes contexts for the help system.
-
-
Specified by:
-
computeContexts
in interface
IContextComputer
-
-
Parameters:
-
event
- the help event which triggered this request for help
-
Returns:
- a mixed-type array of context ids (type
String
)
and/or help contexts (type IContext
) -
See Also:
-
IContext
getLocalContexts
public
Object[] getLocalContexts(
HelpEvent event)
-
Deprecated.
-
Description copied from interface:
IContextComputer
- Returns the local contexts for this context computer.
Typically this method is called by other instances of
IContextComputer
in their computeContexts
method.
The important concept here is that the value returned by
computeContexts
represents the complete help
contexts and is passed directly to the help support system.
However the value returned by this method represents the
only the contexts for the particular control with which this
IContextComputer
is associated.
-
-
Specified by:
-
getLocalContexts
in interface
IContextComputer
-
-
Parameters:
-
event
- the help event which triggered this request for help
-
Returns:
- a mixed-type array of context ids (type
String
)
and/or help contexts (type IContext
) -
See Also:
-
IContext
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.