| Home >> All >> nextapp >> [ echo Javadoc ] |
• nextapp.echo: Javadoc index of package nextapp.echo.
Package Samples:
• nextapp.echoservlet.util: Provides the core functionality of the Echo Application Container.
• nextapp.echo.util: Provides the core classes for creating Echo applications.
• nextapp.echo.event
• nextapp.echo.table
• nextapp.echo.text
• nextapp.echo.test
• nextapp.echoservlet.html
• nextapp.echoservlet.image
• nextapp.echoservlet.resource
• nextapp.echoservlet.ui
Classes:
• Controller: The Controller is a service that is used to receive input from the client and issue commands to it. Every window of an Echo application contains a frameset at its root. This frameset contains two frames: The first, which fills 100% of the window, is whatever content service (e.g. a ContainerPane or ContentPane) the application desires to display in the window. The second frame is a Controller frame, which occupies 0% of the window, and is thus entirely hidden from view (although it can be made enabling certain debugging options in your application's servlet properties file). The HTML document rendered ...
• ComponentStyle: A CSS style handler for a ComponentPeer . This class has an unusual design as it is intended to minimize the number of CSS style definitions generated for a given HTML document. Minimizing the number of styles is necessary as, if an independent style were to be generated for each and every component, more complex documents would have a ridiculous quantity of CSS code. To create a ComponentPeer that will render a component using a CSS style generated by ComponentStyle you must follow this procedure: Create a ComponentStyle for your ComponentPeer : ComponentStyle style = ComponentStyle.forComponent(this); ...
• Template: A service which produces templated text output. Templates are used in cases where the server must render a mostly static document that contains text that may vary. This service is similar to StaticText , but offers the ability to have dynamically inserted text at specified points. A dynamic area is specified by adding a "variable name" to the template. Variables names are enclosed in dollar signs. The following example document shows how a Template can be used: In the year $Year$, annual sales were $$$AnnualSales$. This sample has two variables, "Year" and "Annual Sales". ...
• Initializer: The service is responsible for initializing applications. This is the first service that will be invoked when an application starts up. It provides a client detection page that will use JavaScript to gather information about public properties of the client browser, storing them in a form. The form is submitted immediately thereafter, invoking this service a second time. The form data will be parsed by a new ClientProperties object that is created from this service. An InstancePeer and related objects are then created for the application, stored in the user's session, and initialized. The service() ...
• DynamicIntegerArray: A limited implementation of a variable-length array of integers. Because the get() method of this object returns a primitive integer type, the user must specify a value that should be returned in the even no value is contained at the specified index when it is called. This value is permanently set at instantiation. This class is VERY inefficient when used to store only a few values at high indices. This object will allocate an array with containers at values from 0 to the highest set index. This class is a supporting class for the Echo framework. It is not intended for use by applications.
• PeerFactory: Generates "peer" objects for objects based on associations. Associations are stored in a properties files, where the keys are the fully qualified class names of objects and the values are the fully qualified class names of their peers. When an object is passed to the createPeer() method its peer will be returned based on the bindings in the properties file. An objects superclass(es) will also be tested for available peers if none is available for the derived class. If no peer is found, a PeerFactoryException is thrown.
• Service: An interface for objects that process Connection s, parsing an HTTP request and producing an HTTP response. Every service is identified by a unique Id . When the client browser makes a request of the server and provides the Service Id of this service, its service() method will be invoked. Every request to an Echo application from a client browser will invoke a service. Services must be registered with the ServiceRegistry before they can be used.
• AbstractTableModel: An abstract implementation of a table model. This class provides listener management and convenience methods for notifying listeners of events. It provides generic implementations of getColumnClass() (which always returns Object.class) and getColumnName() (which returns "spreadsheet-style" column names). It also provides an empty implementation of setValueAt(). This class should be extended when you desire to create a TableModel which is best served by a custom representation of its internal data.
• ContainerPane: A container used to lay out panes within a window. Only AbstractPane s, e.g. ContainerPane s, ContentPane s, and HttpPane s may be added as children to a ContainerPane . Adding components that do not subclass AbstractPane will result in undocumented behavior. ContainerPane s may only be added as children to Window s and other ContainerPane s.
• WindowUI: A peer object for Window s. This class is responsible for rendering the root document of each browser window, which contains a <frameset> that references the window's content and the Controller document. Windows also contain the client model object script and additional JavaScript functions for maintaining application state.
• TriCellTable: Renders an HTML table that has two or three "container" cells and independently settable margins between them. These tables are useful for rendering buttons that have two or three elements (images, text labels, and state indicators). This class supports all possible permutations for placement of each of the two or three contained components.
• ControllerFieldInitialState: An interface implemented by component peers that need state data available via the initial value of the component's client input field in the controller form. The value returned by the getControllerFieldValue at render-time will be available via a client-side JavaScript call to E_getParameter();
• OutgoingUpdateQueue: Manages outgoing updates to the client. Managed updates include: Panes requiring refresh Windows requiring refresh Windows requiring title update Windows requiring z-index adjustment (raising or lowering) Windows to be opened or closed
• StackedPane: A stacked pane resembles a stack of cards in concept. While panes may be added and removed from a StackedPane, only the top pane is visible. A StackedPane is useful when an application needs to offer a user interface where users can navigate down and then back up a hierarchy.
• AbstractSelectFieldModel: A base class from which SelectFieldModel implementations are derived. This class provides event handling functionality and storage of the selected item. If storage of the selected item is not desired, the getSelectedItem() and setSelectedItem() fields may be overridden.
• CookieManager: A utility class used to cookies set by an application on the client browser. Applications may obtain access to this object by retrieving their ServerContext from their EchoInstance and calling ServerContext.getCookieManager() .
• CacheableService: An interface implemented by services that may be cached for a period of time by the client browser. If a service desires to be cacheable for the entire browser session, it should always return a constant value from its getVersion() method.
• InitialParameters: An interface provided to an EchoInstance such that it may access the parameters that were initially passed to the application container. An instance of an implementation of this interface is set as an attribute with ATTRIBUTE_NAME
• ClientInputProducer: An interface used by ComponentPeer s to receive input from the client browser. Implementing this interface will automatically generate a hidden input field on the client in the form rendered by the Controller .
• ServerContext: An interface provided to an EchoInstance such that it may access certain facilities available in the application container. An instance of an implementation of this interface is set as an attribute with ATTRIBUTE_NAME
• RenderingContext: An object that is passed to Component Peers as they are being rendered that holds pertinent information: The Connection the peer is to be rendered to and the HtmlDocument the peer will be rendered in.
• Version: Utility class for comparing version numbers in String format. This class may be used to determine if a version number is greater than another to make a hypothesis about whether the version is compatible with a requirement.
| Home | Contact Us | Privacy Policy | Terms of Service |