| Home >> All >> org >> apache >> [ tapestry Javadoc ] |
Page 1 2 3 4
• org.apache.tapestry: Javadoc index of package org.apache.tapestry.
Package Samples:
• org.apache.tapestry.enhance.javassist: Classes used for performing dynamic bytecode enhancement of component and page classes.
• org.apache.tapestry.contrib.ejb
• org.apache.tapestry.contrib.form
• org.apache.tapestry.contrib.informal
• org.apache.tapestry.contrib.inspector
• org.apache.tapestry.contrib.jdbc
• org.apache.tapestry.contrib.palette
• org.apache.tapestry.contrib.popup
• org.apache.tapestry.contrib.table.components.inserted
• org.apache.tapestry.contrib.table.components
• org.apache.tapestry.contrib.table.example.minimal
• org.apache.tapestry.contrib.table.model.common
• org.apache.tapestry.contrib.table.model.ognl
• org.apache.tapestry.contrib.table.model.simple
• org.apache.tapestry.contrib.table.model.sql
• org.apache.tapestry.contrib.table.model
• org.apache.tapestry.contrib.valid
• org.apache.tapestry.asset
• org.apache.tapestry.bean
• org.apache.tapestry.binding
Classes:
• Palette: A component used to make a number of selections from a list. The general look is a pair of <select> elements. with a pair of buttons between them. The right element is a list of values that can be selected. The buttons move values from the right column ("available") to the left column ("selected"). This all takes a bit of JavaScript to accomplish (quite a bit), which means a org.apache.tapestry.html.Body component must wrap the Palette. If JavaScript is not enabled in the client browser, then the user will be unable to make (or change) any selections. Cross-browser compatibility is not perfect. ...
• IValidationDelegate: Interface used to track validation errors in forms and org.apache.tapestry.form.IFormComponent s (including org.apache.tapestry.form.AbstractTextField and its subclasses). In addition, controls how fields that are in error are presented (they can be marked in various ways by the delegate; the default implementation adds two red asterisks to the right of the field). The interface is designed so that a single instance can be shared with many instances of org.apache.tapestry.form.IFormComponent . Starting with release 1.0.8, this interface was extensively revised (in a non-backwards compatible way) ...
• TableView: A low level Table component that wraps all other low level Table components. This component carries the org.apache.tapestry.contrib.table.model.ITableModel that is used by the other Table components. Please see the documentation of org.apache.tapestry.contrib.table.model.ITableModel if you need to know more about how a table is represented. This component also handles the saving of the state of the model using an org.apache.tapestry.contrib.table.model.ITableSessionStateManager to determine what part of the model is to be saved and an org.apache.tapestry.contrib.table.model.ITableSessionStoreManager ...
• TemplateParser: Parses Tapestry templates, breaking them into a series of tokens . Although often referred to as an "HTML template", there is no real requirement that the template be HTML. This parser can handle any reasonable SGML derived markup (including XML), but specifically works around the ambiguities of HTML reasonably. Dynamic markup in Tapestry attempts to be invisible. Components are arbitrary tags containing a jwcid attribute. Such components must be well balanced (have a matching close tag, or end the tag with " /> ". Generally, the id specified in the template is matched against an component defined ...
• AbstractEngine: Basis for building real Tapestry applications. Immediate subclasses provide different strategies for managing page state and other resources between request cycles. Note: much of this description is in transition as part of Tapestry 3.1. All ad-hoc singletons and such are being replaced with HiveMind services. Uses a shared instance of ITemplateSource , ISpecificationSource , IScriptSource and IComponentMessagesSource stored as attributes of the javax.servlet.ServletContext (they will be shared by all sessions). An engine is designed to be very lightweight. Particularily, it should never hold references ...
• ExternalService: The external service enables external applications to reference Tapestry pages via a URL. Pages which can be referenced by the external service must implement the org.apache.tapestry.IExternalPage interface. The external service enables the bookmarking of pages. The external service may also be used by the Tapestry JSP taglibrary ( org.apache.tapestry.jsp.ExternalURLTag and org.apache.tapestry.jsp.ExternalTag ). You can try and second guess the URL format used by Tapestry. The default URL format for the external service is: http://localhost/app?service=external/ [Page Name] &sp=[Param 0]&sp=[Param ...
• ListEditMap: A utility class often used with the ListEdit component. A ListEditMap is loaded with data objects before the ListEdit renders, and again before the ListEdit rewinds. This streamlines the synchronization of the form against data on the server. It is most useful when the set of objects is of a manageable size (say, no more than a few hundred objects). The map stores a list of keys, and relates each key to a value. It also tracks a deleted flag for each key. Usage: The page or component should implement org.apache.tapestry.event.PageRenderListener and implement PageRenderListener.pageBeginRender(org.apache.tapestry.event.PageEvent) ...
• MultiplePropertySelection: A component which uses <input type=checkbox> to set a property of some object. Typically, the values for the object are defined using an org.apache.commons.lang.enum.Enum . A MultiplePropertySelection is dependent on an {link IPropertySelectionModel} to provide the list of possible values. Often, this is used to select one or more org.apache.commons.lang.enum.Enum to assign to a property; the org.apache.tapestry.form.EnumPropertySelectionModel class simplifies this. The org.apache.tapestry.contrib.palette.Palette component is more powerful, but requires client-side JavaScript and is not fully ...
• AdaptorRegistry: An implementation of the Adaptor pattern. The adaptor pattern allows new functionality to be assigned to an existing class. As implemented here, this is a smart lookup between a particular class (the class to be adapted, called the subject class ) and some object instance that can provide the extra functionality (called the adaptor ). The implementation of the adaptor is not relevant to the AdaptorRegistry class. Adaptors are registered before they can be used; the registration maps a particular class to an adaptor instance. The adaptor instance will be used when the subject class matches the registered ...
• ExpressionBinding: Implements a dynamic binding, based on getting and fetching values using JavaBeans property access. This is built upon the OGNL library. Optimization of the Expression There's a lot of room for optimization here because we can count on some portions of the expression to be effectively static. Note that we type the root object as org.apache.tapestry.IComponent . We have some expectations that certain properties of the root (and properties reachable from the root) will be constant for the lifetime of the binding. For example, components never change thier page or container. This means that certain ...
• AssetExternalizer: Responsible for copying assets from the classpath to an external directory that is visible to the web server. The externalizer is stored inside the javax.servlet.ServletContext as a named attribute. The externalizer uses the name org.apache.tapestry.AssetExternalizer. application name . It configures itself using two additional properties (searching in IEngine.getPropertySource() > IEngine.getPropertySource() 55 . Parameter Description org.apache.tapestry.asset.dir The directory to which assets will be copied. org.apache.tapestry.asset.URL The corresponding URL for the asset directory. If either ...
• Pool: A Pool is used to pool instances of a useful class. It uses keys, much like a java.util.Map , to identify a list of pooled objects. Retrieving an object from the Pool atomically removes it from the pool. It can then be stored again later. In this way, a single Pool instance can manage many different types of pooled objects, filed under different keys. Unlike traditional Pools, this class does not create new instances of the objects it stores (with the exception of simple Java Beans, via retrieve(Class) 55 . The usage pattern is to retrieve an instance from the Pool, and if the instance is null, ...
• NumericField: Backwards compatible version of the 1.0.7 NumericField component. Parameter Type Read / Write Required Default Description value java.lang.Number R / W yes The value to be updated. When the form is submitted, this parameter is only updated if the value is valid. When rendering, a null value will render as the empty string. A value of zero will render normally. When the form is submitted, the type of the binding is used to determine what kind of object to convert the string to. minimum java.lang.Number R no The minimum value accepted for the field. maximum java.lang.Number R no ...
• ExternalCallback: A callback for returning to an org.apache.tapestry.IExternalPage . Example usage of ExternalCallback : The External page ensure a user is authenticated in the IPage.validate(IRequestCycle) > IPage.validate(IRequestCycle) 55 method. If the user is not authenticated, they are redirected to the Login page, after setting a callback in the Login page. The Login page formSubmit() org.apache.tapestry.IActionListener authenticates the user and then invokes ICallback.performCallback(IRequestCycle) 55 to the External page. public class External extends BasePage implements IExternalPage { private Integer ...
• RequestContext: This class encapsulates all the relevant data for one request cycle of an ApplicationServlet . This includes: javax.servlet.http.HttpServletRequest javax.servlet.http.HttpServletResponse javax.servlet.http.HttpSession javax.servlet.http.HttpServlet It also provides methods for: Retrieving the request parameters (even if a file upload is involved) Getting, setting and removing request attributes Forwarding requests Redirecting requests Getting and setting Cookies Intepreting the request path info Writing an HTML description of the RequestContext (for debugging). If some cases, it is necesary to ...
• BlockRenderer: An implementation of IRender that renders a Block component. The BlockRenderer allows the contents of a Block to be rendered via org.apache.tapestry.IRender . It can be used in cases when an org.apache.tapestry.IRender object is required as an argument or a binding to render a part of a Component. To provide a complicated view, it could be defined in a Block and then returned encapsulated in a BlockRenderer. It is important to note that a special care has to be taken if the BlockRenderer is used within an inner class of a component or a page. In such a case the instance of the component that created ...
• DateField: Backwards compatible version of the 1.0.7 DateField component. Parameter Type Read / Write Required Default Description date java.util.Date R / W yes The date property to edit. required boolean R no no If true, then a value must be entered. minimum java.util.Date R no If provided, the date entered must be equal to or later than the provided minimum date. maximum java.util.Date R no If provided, the date entered must be less than or equal to the provided maximum date. displayName String R yes A textual name for the field that is used when formulating error messages. format ...
• RenderBlock: Renders the text and components wrapped by a Block component. [ Component Reference ] It is possible for an RenderBlock to obtain a Block from a page other than the render page. This works, even when the Block contains links, forms and form components. The action and direct services will create URLs that properly address this situation. However, because the rendering page can't know ahead of time about these foriegn Blocks, org.apache.tapestry.event.PageRenderListener methods (for components and objects of the foriegn page) via RenderBlock will not be executed. This specifically affects the methods ...
• StatementAssembly: Class for creating and executing JDBC statements. Allows statements to be assembled incrementally (like a java.lang.StringBuffer ), but also tracks parameters, shielding the developer from the differences between constructing and using a JDBC java.sql.Statement and a JDBC java.sql.PreparedStatement . This class is somewhat skewed towards Oracle, which works more efficiently with prepared staments than simple SQL. In addition, implements toString() 55 in a useful way (you can see the SQL and parameters), which is invaluable when debugging. addParameter(int) 55 (and all overloaded versions of it ...
• PageSpecificationResolverImpl: Performs the tricky work of resolving a page name to a page specification. The search for pages in the application namespace is the most complicated, since Tapestry searches for pages that aren't explicitly defined in the application specification. The search, based on the simple-name of the page, goes as follows: As declared in the application specification simple-name .page in the same folder as the application specification simple-name page in the WEB-INF/ servlet-name directory of the context root simple-name .page in WEB-INF simple-name .page in the application root (within the context root) ...
• PageCallback: Simple callback for returning to a page. Example usage of PageCallback : The Home page ensure a user is authenticated in the IPage.validate(IRequestCycle) > IPage.validate(IRequestCycle) 55 method. If the user is not authenticated, they are redirected to the Login page, after setting a callback in the Login page. The Login page formSubmit() org.apache.tapestry.IActionListener authenticates the user and then invokes ICallback.performCallback(IRequestCycle) 55 to the Home page. public class Home extends BasePage { public void validate(IRequestCycle cycle) { Visit visit = (Visit) getVisit(); if (!visit.isAuthenticated()) ...
• ComponentSpecificationResolverImpl: Utility class that understands the rules of component types (which may optionally have a library prefix) and can resolve the type to a org.apache.tapestry.INamespace and a org.apache.tapestry.spec.IComponentSpecification . Like PageSpecificationResolver , if the component is not defined explicitly in the namespace, a search may occur: Performs the tricky work of resolving a page name to a page specification. The search for pages in the application namespace is the most complicated, since Tapestry searches for pages that aren't explicitly defined in the application specification. The search, based ...
• ValidatingTextField: Backwards compatible version of the 1.0.7 ValidatingTextField component. Parameter Type Read / Write Required Default Description text java.lang.String R / W yes The text inside the text field. When the form is submitted, the binding is only updated if the value is valid. minimumLength int R no 0 The minimum length (number of characters read) for the field. The value provided in the request is trimmed of leading and trailing whitespace. If a field is not required and no value is given, then minimumLength is ignored. Minimum length only applies if some non-null value is given. required boolean ...
• ScriptParser: Parses a Tapestry Script, an XML file defined by one of the following public identifiers: -//Primix Solutions//Tapestry Script 1.0//EN -//Howard Ship//Tapestry Script 1.1//EN -//Howard Lewis Ship//Tapestry Script 1.2//EN . The version 1.1, is largely backwards compatible to the old script, but adds a number of new features (if, if-not, foreach and the use of property paths with insert). Version 1.2 removes the <insert> element, using an Ant-like syntax ( ${ expression } ). It also replaces the attribute name property-path with expression (because OGNL is used). A Tapestry Script is used, ...
• IPropertySelectionModel: Used by a PropertySelection to provide labels for options. The component requires three different representations of each option: The option value, a Java object that will eventually be assigned to a property The label, a String which is incorprated into the HTML to identify the option to the user The value, a String which is used to represent the option as the value of the <option> or <input type=radio> generated by the PropertySelection . The option is usually either an org.apache.commons.lang.enum.Enum (see EnumPropertySelectionModel ) or some kind of business object. The label is ...
| Home | Contact Us | Privacy Policy | Terms of Service |