Home >> All >> org >> apache >> [ ecs Javadoc ]

•	org.apache.ecs.examples.* (1)	•	org.apache.ecs.factory.* (1)	•	org.apache.ecs.filter.* (5)
•	org.apache.ecs.html.* (91)	•	org.apache.ecs.html2ecs.* (1)	•	org.apache.ecs.jsp.* (15)
•	org.apache.ecs.rtf.* (46)	•	org.apache.ecs.storage.* (3)	•	org.apache.ecs.vxml.* (52)
•	org.apache.ecs.wml.* (45)	•	org.apache.ecs.xhtml.* (91)	•	org.apache.ecs.xml.* (3)

• org.apache.ecs: Javadoc index of package org.apache.ecs.


Package Samples:

• org.apache.ecs.examples
• org.apache.ecs.factory
• org.apache.ecs.filter
• org.apache.ecs.html
• org.apache.ecs.html2ecs
• org.apache.ecs.jsp
• org.apache.ecs.rtf
• org.apache.ecs.storage
• org.apache.ecs.vxml
• org.apache.ecs.wml
• org.apache.ecs.xhtml
• org.apache.ecs.xml

Classes:

• HtmlTree: This JavaBean returns the hierarchical structure described in a javax.swing.tree.DefaultMutableTreeNode as valid XHTML. This class is a very simple counterpart of the javax.swing.JTree with the exception that the external Controller is integrated into this View. If you want your tree elements (nodes and leafs) to be marked with an anchor, you'll have to make sure that the name of your node contains such an anchor. A specific node in a tree can be identified by a path, described as colon separated integer values (e.g. "0:1"). Unlike Swing's JTree component, this JavaBean expands only the ...
• Option: This class creates a <Option> tag. The Option tag now defaults to having a closing </Option> (as is now required). This can be overridden by setNeedClosingTag(false). This change means that you should construct select options element in the following manner: new org.apache.ecs.html.Select .addElement(new option("value1").addElement("text1")) .addElement(new option("value2").addElement("text2")) rather than new org.apache.ecs.html.Select .addElement(new option("value1").addElement("text1") .addElement(new option("value2").addElement("text2"))) (this change should not break existing code ...
• RegexpFilter: This filter uses regexp to create expressions and allows you do a replace on them. It works like the Perl function called subst. Given a regular expression of "a*b", and a String to substituteIn of "aaaabfooaaabgarplyaaabwackyb" and the substitution String "-", the resulting String returned by subst would be "-foo-garply-wacky-". Filter filter = new RegexpFilter(); filter.addAttribute("a*b","-"); String text = "aaaabfooaaabgarplyaaabwackyb"; String result = filter.process(text); System.out.println(result); Produces: -foo-garply-wacky- Note: "a*" means 0 or more occurences of 'a', therefore the ...
• ECSDefaults: This class is responsible for loading the ecs.properties file and getting the default settings for ECS. This allows you to edit a simple text file instead of having to edit the .java files and recompile. The property file can be specified via the 'ecs.properties' system property. For example, java -Decs.properties="my.ecs.properties". If ecs.properties is null then the standard ecs.properties resource in the ECS jar is used. If the property file cannot be loaded, a message is printed to standard error and hard-coded defaults are used instead.
• WordFilter: This filter uses StringTokenizer to create "words" and allow you to replace on those "words". A word is defined as anything between two spaces. This filter should be relatively fast and shows how easy it is to implement your own filters. Filter filter = new WordFilter(); filter.addAttribute("there","where"); filter.addAttribute("it","is"); filter.addAttribute("goes","it"); P p = new P(); p.setFilter(filter); p.addElement("there it goes"); System.out.println(p.toString()); Produces: <p>where is it
• Html2Ecs: The point of this class is to create an HTML file -> ECS code converter. It is NOT required for ECS core execution. If it does not compile, it is because you need to get the Xerces XML parser for Java from xml.apache.org . This class is presently fairly broken and is really only shown as an example. Contributions towards making this class would be MOST appreciated. Please subscribe to the ECS mailing list and express your interest there.
• CharacterFilter: This class creates a Filter object. The default characters filtered are: " ' & For example: Filter filter = new CharacterFilter(); filter.addAttribute("$","dollar"); filter.addAttribute("#",Entities.POUND); P p = new P(); p.setFilter(filter); Document doc = new Document(); doc.getBody().addElement(p); The filter is applied when the addElement() method is called.
• Filter: This class creates an interface for all filters. For example: Filter filter = new CharacterFilter(); filter.addAttribute("$","dollar"); filter.addAttribute("#",Entities.POUND); P p = new P(); p.setFilter(filter); Document doc = new Document(); doc.getBody().addElement(p); The filter is applied when the addElement() method is called.
• Doctype: This class creates a <!DOCTYPE> tag. Format: <!DOCTYPE [name] [visibility] [identifier] [uri]> usage: Document d = new Document() .setDoctype(new Doctype.Html40Strict()) or XMLDocument d = new XMLDocument() .addToProlog( new Doctype( "foo", "\"--/bar/baz/en\"", "\"http://qoz.net/foo.dtd\"" ); .addElement( new XML( ...
• ElementContainer: This class is a Element container class. You can place elements into this class and then you can place this class into other elements in order to combine elements together. P p = new P().addElement("foo"); P p1 = new P().addElement("bar"); ElementContainer ec = new ElementContainer(p).addElement(p1); System.out.println(ec.toString());
• Td: This class implements the <td> element. It is a container to hold a single table cell data within a table row. Table cell data may be empty. Empty cells are significant, and must not be ignored. The user agent should do a best effort to deal with multiple line data cells that may result from using images or line breaks.
• script: This class creates a <script> tag. Note that XHTML script tag doesn't hide the script text withing comments like its HTML counterpart does. This difference is caused by the fact that XHTML is XML and XML parsers can throw the comments out. Use this tag with browsers that support scripting language(s).
• Select: This class creates a <SELECT> tag. Please note that the Option element now defaults to add a closing tag (as is now required by the specification).
• VXMLDocument: VXMLDocument This is the container for XML elements that can be used similar to org.apache.ecs.Document. However, it correctly handles XML elements and doesn't have any notion of a head, body, etc., that is associated with HTML documents.
• XMLDocument: XMLDocument This is the container for XML elements that can be used similar to org.apache.ecs.Document. However, it correctly handles XML elements and doesn't have any notion of a head, body, etc., that is associated with HTML documents.
• Tr: This class implements the <tr> element. Table rows may be empty (for example, all the cells in the row are empty). Empty rows are significant and must not be ignored. This element must contain at least one Td elements i.e. cell data.
• ClearElement: A basic ECS element that doesn't have a filter. This allows content developers to use ECS with legacy applications that want to generate HTML but also be a use raw HTML. Don't use this unless you have to do so for compatibilty reasons
• p: This class creates a <p> tag. The HTML <P> tag defaults to not having a closing </P> because it is optional in the spec. In XHTML this is not allowed, so ending </p> is enforced.

Home | Contact Us | Privacy Policy | Terms of Service