Package org.openide.cookies

Cookies are a design pattern used to add behaviors to existing data object and nodes, or to separate implementation from the main object.

See:
Description

Interface Summary

ArgumentsCookie	Provides ability for a data object or node to be passed runtime arguments.
CloseCookie	Permits an object which was opened to be closed.
CompilerCookie	Provides ability for an object to be compiled.
CompilerCookie.Build	A cookie for unconditional compilation.
CompilerCookie.Clean	A cookie for cleaning before compilation.
CompilerCookie.Compile	A cookie for conditional compilation.
ConnectionCookie	Cookie that allows connection between two objects.
ConnectionCookie.Listener	Cookie that must be provided by a node that is willing to register itself as a listener to a ConnectionCookie.
ConnectionCookie.Type	Interface describing cookie type of event a cookie can produce.
DebuggerCookie	Cookie for debugger.
EditCookie	Cookie permitting objects to be edited.
EditorCookie	Cookie defining standard operations with a text document and an editor that can display it.
ElementCookie	Cookie permitting an object to be used in the Object Browser differently than in the Explorer.
ExecCookie	Cookie for objects which may be executed.
FilterCookie	Cookie for node groups which can somehow be filtered.
InstanceCookie	Cookie that should be provided by all nodes that are able to create a "instance".
InstanceCookie.Of	Enhanced cookie that can answer queries about the type of the instance it creates.
InstanceCookie.Origin	Enhanced instance cookie that also knows the file it was created from and can be serialized back to.
LineCookie	Cookie for data objects that want to provide support for accessing lines in a document.
OpenCookie	Cookie for opening an object.
PrintCookie	Cookie permitting an object to be printed.
ProjectCookie	A cookie that provides project manipulation functionality.
SaveCookie	The cookie for the save operation.
SourceCookie	A cookie for obtaining a source hierarchy from data objects.
SourceCookie.Editor	Extended source cookie permitting for bidirectional translation with Swing text elements.
ViewCookie	Cookie permitting objects to be viewed.

Class Summary

ConnectionCookie.Event

Event that is fired to listeners.

Package org.openide.cookies Description

Cookies are a design pattern used to add behaviors to existing data object and nodes, or to separate implementation from the main object.

The Loaders API describes how to use cookies in conjunction with data objects, including creating new cookie interfaces, creating new cookie support implementations, and reusing existing supports. The Nodes API also permits use of cookies to add behavior to nodes.

For example, the execution cookie, arguments cookie, and debugger cookie specify various ways in which an IDE object (e.g. a compiled class) may be invoked; a reasonable implementation for all three may be created using an execution support, which may be attached to an appropriate data object or node.