JavaScript Development Tools
Release 3.2

org.eclipse.wst.jsdt.libraries
Class BasicBrowserLibraryContainer

java.lang.Object
  extended by org.eclipse.wst.jsdt.libraries.BasicBrowserLibraryContainer
All Implemented Interfaces:
IJsGlobalScopeContainer

public class BasicBrowserLibraryContainer
extends Object
implements IJsGlobalScopeContainer

Container for generic client-side scripting libraries. This container must support all offered versions to avoid duplicates being added into a project's include path.

Path format: org.eclipse.wst.jsdt.launching.baseBrowserLibrary/StandardBrowser/(html5|html4)?


Field Summary
 
Fields inherited from interface org.eclipse.wst.jsdt.core.IJsGlobalScopeContainer
K_APPLICATION, K_DEFAULT_SYSTEM, K_SYSTEM
 
Method Summary
 String getDescription()
          Answers a readable description of this container
 IIncludePathEntry[] getIncludepathEntries()
          Answers the set of includepath entries this container is mapping to.
 int getKind()
          Answers the kind of this container.
 IPath getPath()
          Answers the container path identifying this container.
 String[] resolvedLibraryImport(String a)
          Allows mapping between HTML imports and a toolkit's actual page imports.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getDescription

public String getDescription()
Description copied from interface: IJsGlobalScopeContainer
Answers a readable description of this container

Specified by:
getDescription in interface IJsGlobalScopeContainer
Returns:
String - a string description of the container

getIncludepathEntries

public IIncludePathEntry[] getIncludepathEntries()
Description copied from interface: IJsGlobalScopeContainer
Answers the set of includepath entries this container is mapping to.

The set of entries associated with a includepath container may contain any of the following:

A includepath container can neither reference further includepath containers or includepath variables.

This method is called by the JavaScript model when it needs to resolve this includepath container entry into a list of library and project entries. The method is typically called exactly once for a given JavaScript project, and the resulting list of entries cached internally by the JavaScript model. This method must not be called by other clients.

There are a wide variety of conditions under which this method may be invoked. To ensure that the implementation does not interfere with correct functioning of the JavaScript model, the implementation should use only the following JavaScript model APIs:

The effects of using other JavaScript model APIs are unspecified.

Specified by:
getIncludepathEntries in interface IJsGlobalScopeContainer
Returns:
IIncludePathEntry[] - the includepath entries this container represents
See Also:
IIncludePathEntry

getKind

public int getKind()
Description copied from interface: IJsGlobalScopeContainer
Answers the kind of this container. Can be either: Typically, system containers should be placed first on a build path.

Specified by:
getKind in interface IJsGlobalScopeContainer
Returns:
the kind of this container

getPath

public IPath getPath()
Description copied from interface: IJsGlobalScopeContainer
Answers the container path identifying this container. A container path is formed by a first ID segment followed with extra segments, which can be used as additional hints for resolving to this container.

The container ID is also used to identify aJsGlobalScopeContainerInitializer registered on the extension point "org.eclipse.wst.jsdt.core.JsGlobalScopeContainerInitializer", which can be invoked if needing to resolve the container before it is explicitly set.

Specified by:
getPath in interface IJsGlobalScopeContainer
Returns:
IPath - the container path that is associated with this container

resolvedLibraryImport

public String[] resolvedLibraryImport(String a)
Description copied from interface: IJsGlobalScopeContainer
Allows mapping between HTML imports and a toolkit's actual page imports. Implementers should ensure the validity of the imports before returning a value.

Specified by:
resolvedLibraryImport in interface IJsGlobalScopeContainer

JavaScript Development Tools
Release 3.2

Copyright (c) IBM Corp. and others 2000, 2010. All Rights Reserved.