Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

javax.ide.build.* (5)javax.ide.command.* (6)javax.ide.debug.* (4)
javax.ide.editor.* (7)javax.ide.extension.* (36)javax.ide.log.* (3)
javax.ide.menu.* (20)javax.ide.model.* (136)javax.ide.net.* (7)
javax.ide.property.* (5)javax.ide.spi.* (3)javax.ide.util.* (5)
javax.ide.view.* (9)javax.ide.wizard.* (4)

javax.ide: Javadoc index of package javax.ide.


Package Samples:

javax.ide.menu.spi: The menu registration classes that extension writers use to find information about actions and menus.  
javax.ide.extension.spi: The ide package is where all JSR 198 packages are rooted.  
javax.ide.wizard
javax.ide.wizard.spi
javax.ide.view
javax.ide.util
javax.ide.spi
javax.ide.property.spi
javax.ide.property
javax.ide.net
javax.ide.net.spi
javax.ide.model.xml
javax.ide.model
javax.ide.model.text
javax.ide.model.spi
javax.ide.model.java.source.write
javax.ide.model.java.source.util
javax.ide.model.java.source.tree
javax.ide.model.java
javax.ide.model.java.declaration

Classes:

TreeManager: The TreeManager serves as a FileT factory. Clients obtain FileTs by requesting a FileT from the manager and by creating empty FileTs through the manager. Clients change the writability of FileTs by opening and closing TreeTransactions. For the sake of transaction consistency, a FileT belongs to exactly one TreeManager for the lifetime of the FileT. The TreeManager owns a single lockable resource (which may be itself) which must, at the minumum, provide the functionality of a read-write lock. Each FileT is tied to a single lockable resource (which may be itself) which is defined by the owning IDE ...
EditorManager: The EditorManager manages the life cycle of Editor s. It is also the registry of information about what editors can be used with particular documents. Clients use this class to open an editor on a javax.ide.model.Document . When clients request to open an editor on a specific document, the editor manager performs the following tasks: 1. Create an instance of the requested editor type. If no type is specified, create an instance of the preferred editor associated with the target document. 2. Call the Editor.open(javax.ide.command.Context) 55 method passing the appropriate context. 3. Call the Editor.restore(java.util.prefs.Preferences) ...
DocumentFactory: The DocumentFactory interface is responsible for creating intances of Document s. The type of Document that gets created depends on the java.net.URI that is passed into the findOrCreate(URI) 55 and findOrCreate(MetaClass, URI) 55 methods. The DocumentFactory makes use of registered Recognizer instances to determine what Document class corresponds to a particular java.net.URI . JSR-198 specifies a number of ways to recognize documents: 1. By recognizing characteristics of the URI , 2. For XML documents by recognizing certain markups, and 3. By allowing extension writers to have full control of how ...
VirtualFileSystemHelper: The VirtualFileSystemHelper class specifies the VirtualFileSystem operations that may have scheme-specific handling. By default, the VirtualFileSystem delegates its operations to VirtualFileSystemHelper . However, a subclass of VirtualFileSystemHelper can be registered with the VirtualFileSystem to handle the VirtualFileSystem operations for a particular scheme. A helper class is registered through the VirtualFileSystem.registerHelper(String, VirtualFileSystemHelper) 55 method. Special implementation note : classes that extend VirtualFileSystemHelper must be completely thread-safe because a single ...
AnnotationT: An annotation (not to be confused with annotation type). Any declaration may be annotated, in particular, that means any T that extends HasModifiersT. For more information, please refer to the JLS 3rd ed, section 9.7. The first annotation variant is called a "normal" annotation. Consider: // Normal annotation RequestForEnhancement( id = 2868724, synopsis = "Provide time-travel functionality", engineer = "Mr. Peabody", date = "4/1/2004" ) public static void travelThroughTime(Date destination) { ... } getArguments() will return a list of four elements, each one will be an AssignmentExpressionT. The ...
Document: The Document interface is implemented by objects that can be saved and restored. These objects are generally persisted on some file system and are address using an unique java.net.URI . Documents are generally created using the DocumentFactory . This ensures that there is always one instance of a document pointed to by the same java.net.URI . The specification defines following types of documents: Project s: containing user work, javax.ide.model.text.TextDocument s: encapsulating text based files, javax.ide.model.java.JavaSource s: encapsulating java files, and javax.ide.model.xml.XMLDocument s: ...
URIFactory: This class contains methods which create new instances of java.net.URI . In order for java.net.URI s to be used effectively as keys in a hashtable, the URI must be created in a very consistent manner. Therefore, when creating a new instance of java.net.URI , it is strongly recommended that you use one of the methods in this class rather than calling the java.net.URI constructor directly. This will help prevent subtle bugs that can come up when two java.net.URI instances that should be equal aren't equal (resulting in caching bugs) because of a difference in some detail of the URI that affects the ...
CommandProcessor: The CommandProcessor is responsible for managing the execution of the IDE commands and maintining the undo stack. In general, all Controller implementations should use the IDE command processor to execute the commands that controller handles. IDE service providers must extend this class and provide an implementation of the invoke(Command) 55 method. It is up to the IDE service provider implementation to decide whether it supports undo/redo on a per document, or global basis. If the undo support provided is document based, implementors of this class must make sure that after a command is executed, ...
TypeD: Mirrors a type. Members A member should be listed in its respective member collection if it is either declared or inherited. Members that are not inherited should not be listed. Private members are never inherited. Package-private members are not inherited outside of the declaring package. Public members are always inherited. Note that constructors are never inherited. The order of the member listing should be determined by the type hierarchy. If type B occurs before type A in the type hierarchy, then all of B's declared members should occur before any of A's declared members in the member collection. ...
Command: The Command interface defines the interface of all command objects. This interface consists of a procedure, doit , to execute a command. Concrete Command subclasses implement the necessary behavior to carry out a specific command. This interface also provides additional methods necessary to implement the undo service provided by the CommandProcessor . For the undo mechanism it is necessary to distinguish three types of commands: NO_CHANGE : A command that require no undo. NORMAL : A command that can be undone. NO_UNDO : A command that cannot be undone, and which prevents the undo of previously ...
PropertyPageRegistry: The PropertyPageRegistry is the registry of information describing what extension specific property pages have been added to an IDE. Extensions register property page information in the extension manifest using the property-pages-hook tag. The property pages hook allows extension to declare property pages for the IDE and project preferences. Extension use the property-page object-class tag to specify the object class for which the pages are declared. For example, if the pages are for a project, extension should specify javax.ide.model.Project as the object class. If the pages are for the IDE, extension ...
TreeResolver: The TreeResolver provides a facility for resolving type and declaration references on Trees. Methods are provided for resolving individual Tree objects. Other methods are provided for resolving an entire FileT. The TreeResolver may need to acquire resource(s) as it performs resolution. Callers should be warned that TreeResolver operations may therefore block unless the underlying resource has already been acquired. TODO: How does a caller acquire said resources? In particular, this is a problem since the resolution does not know ahead of time which compilation units will need to be read to perform ...
IconDescription: The description of an icon. An icon is specified either as a key lookup in a resource file which resolves to a resource path relative to the resource file, or an absolute resource path. Use the createPathInstance( ClassLoader, String ) 55 or createResourceInstance( ClassLoader, String, String) 55 factory methods to create an instance of this class. To retrieve the URL of the icon, use getURL() 55 . This URL is normally a resource (i.e. classpath) URL, suitable for use when constructing an ImageIcon or other toolkit specific image type.
Version: Represents the version number of an extension or component. A version number is an immutable ordered sequence of integer values. Version numbers can be represented in two forms. When you construct a new Version object using a String representation of the version number, this String representation is stored and returned by the toString() 55 method. This form of the version number will retain any redundant leading zeros in any of the integer values which make up the version number. Conversely, in the canonical form, a version number does not retain leading zeros. The canonical form of new Version( ...
VirtualFileSystem: The VirtualFileSystem class is responsible for encapsulating the notion of file system operations on content that is pointed to by an java.net.URI . The behavior of VirtualFileSystem can be extended by subclasses of VirtualFileSystemHelper . An instance of VirtualFileSystemHelper is registered with VirtualFileSystem in association with a particular scheme. Scheme-specific behavior can thus be encapsulated by a specific implementation of VirtualFileSystemHelper . IDE implementations do not need to register an implementation of this service. The default registered implementation delegates most of ...
Context: The Context class provides information about the state of the IDE when a command is in the process of being executed. Such information includes: the javax.ide.model.Document the user is working on, the javax.ide.model.Project the user is working on, and the currently selected javax.ide.model.Element s in the active javax.ide.view.View . In addition, to this information, the context allows clients to store arbitrary data to pass on to a command. Such data is stored in the context under a client specified string key. The data can be retrieved using that same key.
I18NCharVisitor: An element visitor that processes xml elements of type i18n_char. If the element has an rskey attribute and an ancestor extension element defined a bundle using the rsbundle attribute, this implementation will use ResourceBundle.getBundle() to load a string resource from the bundle class. If no rskey attribute is present, the text of the element will be used instead. In either case, characterValue( ElementContext, char ) 55 is called with the first non-whitespace character of the resulting string. An error is logged if the rskey attribute is present on the element but no rsbundle was defined in ...
Stack: Convenient implementation of a Last In First Out (LIFO) stack. This implementation differs from the one in java.util.Stack in two ways. First, like most of the collection APIs, it is unsynchronized for better performance when synchronization is not required. If a synchronized stack is required, you can use the Collections.synchronizedCollection() 55 method to retrieve a synchronized instance. Second, it does not expose its internal implementation via its superclass. Extending AbstractCollection instead of Vector allows objects of this class to be used interchangably with other collection framework ...
ClientConnector: ClientConnectors expect extension writers to start the debuggee process by calling Connector.startDebuggee(java.util.Map) 55 . Once the debuggee is launched, the extension writer can attach the debugger to the debugge by calling attachDebugger() 55 . IDE providers must provide an implementation of this interface. Extension writers can access the Connector through the Debugger.getClientConnector(javax.ide.command.Context) 55 method.
I18NStringVisitor: An element visitor that processes xml elements of type i18n_string. If the element has an rskey attribute and an ancestor extension element defined a bundle using the rsbundle attribute, this implementation will use ResourceBundle.getBundle() to load a string resource from the bundle class. If no rskey attribute is present, the text of the element will be used instead. In either case, string( ElementContext, String ) 55 is called with the resulting string. An error is logged if the rskey attribute is present on the element but no rsbundle was defined in an ancestor extension element.
EditorListener: The EditorListener interface should be implemented by clients that are interested in receiving notifications about Editor instances being opened, activated, deactivated, or closed in the IDE. This allows clients to attach to or detach from the given Editor for the purpose of providing extra functionality. For example, the debugger may use this for determining when a Code Editor is opened so that it can display the breakpoint icon locations properly. Clients should register listeners with the EditorManager singleton instance. When an editor is opened, the opened() method will be called. When an ...
TreeKind: The TreeKind enumeration identifies each individual kind of Tree. For code-readability, all constants have been prefixed as TREE_*. Constants for subinterfaces of StatementT have been prefixed as TREE_STMT_*. Constants for subinterfaces of ExpressionT have been prefixed as TREE_EXPR_*. Constants for subinterfaces of DocT have been prefixed as TREE_DOC_*. Though the doc structure is not part of the Java Language specification (moreover, there is no specification of doc structure), doc comment constants have been included because refactoring features may need to access and mutate doc comment contents. ...
Connector: The Connector interface is used to connect to a debugging session. The Connector object is used to start the debuggee or to retrieve command line options so the extension can start the debuggee itself. IDE providers must provide an implementation of this interface. Extension writers can access the Connector through the Debugger.getClientConnector(javax.ide.command.Context) 55 and Debugger.getServerConnector(javax.ide.command.Context) 55 methods.
ServerConnector: ServerConnectors allow clients to start the debugger listening by calling the method startListening() 55 waiting for a debuggee process to start. The debugge process can be started by the extension or the IDE. When the debuggee process is launched, the listening debugger will automatically accept the connection. IDE providers must provide an implementation of this interface. Extension writers can access the Connector through the Debugger.getServerConnector(javax.ide.command.Context) 55 method.
ID: Class used to identify objects. A ID is made up of the object type and a object name. In general, the object type is a generic type identifying similar objects and the object name is the specific name of the object. By convention, the object type identifier is a dash or dot separated string whose uniqueness comes from following the package naming scheme of an extension. In general, an IDE has a set of objects that extensions need to get a hold of. Such objects, which include actions and views for example, implment the javax.ide.Identifiable interface and have an ID that uniquely identifies them ...

Home | Contact Us | Privacy Policy | Terms of Service