Java Doc for PageEnvelope.java in  » Content-Management-System » apache-lenya-2.0 » org » apache » lenya » cms » publication » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation 1.  6.0 JDK Core 2.  6.0 JDK Modules 3.  6.0 JDK Modules com.sun 4.  6.0 JDK Modules com.sun.java 5.  6.0 JDK Modules sun 6.  6.0 JDK Platform 7.  Ajax 8.  Apache Harmony Java SE 9.  Aspect oriented 10.  Authentication Authorization 11.  Blogger System 12.  Build 13.  Byte Code 14.  Cache 15.  Chart 16.  Chat 17.  Code Analyzer 18.  Collaboration 19.  Content Management System 20.  Database Client 21.  Database DBMS 22.  Database JDBC Connection Pool 23.  Database ORM 24.  Development 25.  EJB Server geronimo 26.  EJB Server GlassFish 27.  EJB Server JBoss 4.2.1 28.  EJB Server resin 3.1.5 29.  ERP CRM Financial 30.  ESB 31.  Forum 32.  GIS 33.  Graphic Library 34.  Groupware 35.  HTML Parser 36.  IDE 37.  IDE Eclipse 38.  IDE Netbeans 39.  Installer 40.  Internationalization Localization 41.  Inversion of Control 42.  Issue Tracking 43.  J2EE 44.  JBoss 45.  JMS 46.  JMX 47.  Library 48.  Mail Clients 49.  Net 50.  Parser 51.  PDF 52.  Portal 53.  Profiler 54.  Project Management 55.  Report 56.  RSS RDF 57.  Rule Engine 58.  Science 59.  Scripting 60.  Search Engine 61.  Security 62.  Sevlet Container 63.  Source Control 64.  Swing Library 65.  Template Engine 66.  Test Coverage 67.  Testing 68.  UML 69.  Web Crawler 70.  Web Framework 71.  Web Mail 72.  Web Server 73.  Web Services 74.  Web Services apache cxf 2.0.1 75.  Web Services AXIS2 76.  Wiki Engine 77.  Workflow Engines 78.  XML 79.  XML UI Java Java Tutorial Java Open Source Jar File Download Java Articles Java Products Java by API Photoshop Tutorials Maya Tutorials Flash Tutorials 3ds-Max Tutorials Illustrator Tutorials GIMP Tutorials C# / C Sharp C# / CSharp Tutorial C# / CSharp Open Source ASP.Net ASP.NET Tutorial JavaScript DHTML JavaScript Tutorial JavaScript Reference HTML / CSS HTML CSS Reference C / ANSI-C C Tutorial C++ C++ Tutorial Ruby PHP Python Python Tutorial Python Open Source SQL Server / T-SQL SQL Server / T-SQL Tutorial Oracle PL / SQL Oracle PL/SQL Tutorial PostgreSQL SQL / MySQL MySQL Tutorial VB.Net VB.Net Tutorial Flash / Flex / ActionScript VBA / Excel / Access / Word XML XML Tutorial Microsoft Office PowerPoint 2007 Tutorial Microsoft Office Excel 2007 Tutorial Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » Content Management System » apache lenya 2.0 » org.apache.lenya.cms.publication   Source Cross Reference   Class Diagram   Java Document (Java Doc)   java.lang.Object    org.apache.lenya.cms.publication.PageEnvelope All known Subclasses:   org.apache.lenya.cms.publication.TestPageEnvelope, PageEnvelope public class PageEnvelope (Code) A page envelope carries a set of information that are needed during the presentation of a document. Field Summary final public static  String AREA      final public static  String BREADCRUMB_PREFIX      final public static  String CONTEXT      final public static  String DEFAULT_LANGUAGE      final public static  String DEFAULT_PREFIX      final public static  String DOCUMENT      final public static  String DOCUMENT_EXTENSION      final public static  String DOCUMENT_FILE      final public static  String DOCUMENT_ID      final public static  String DOCUMENT_LABEL      final public static  String DOCUMENT_LANGUAGE      final public static  String DOCUMENT_LANGUAGES      final public static  String DOCUMENT_LANGUAGES_CSV      final public static  String DOCUMENT_LASTMODIFIED      final public static  String DOCUMENT_NAME      final public static  String DOCUMENT_PARENT      final public static  String DOCUMENT_PATH      final public static  String DOCUMENT_SOURCE_EXTENSION      final public static  String DOCUMENT_TYPE      final public static  String DOCUMENT_URL      final public static  String DOCUMENT_URL_WITHOUT_LANGUAGE      DOCUMENT_URL_WITHOUT_LANGUAGE The URL of the current document without a language extension. final public static  String DOCUMENT_UUID      final public static  String IS_PUBLICATION      IS_PUBLICATION If the current URL refers to a publication ("true" or "false"). final public static  String LANGUAGE      This attribute returns the document language if the document exists, or the default language otherwise. final public static  String NAMESPACE      final public static  String[] PARAMETER_NAMES      The names of the page envelope parameters. final public static  String PUBLICATION      final public static  String PUBLICATION_ID      final public static  String PUBLICATION_LANGUAGES_CSV      final public static  String SSL_PREFIX      Constructor Summary protected   PageEnvelope()      Constructor. public   PageEnvelope(DocumentFactory map, String contextPath, String webappUrl, File servletContext, Publication publication)      Creates a page envelope from an object model. Method Summary protected  String createExceptionMessage(Request request)      Creates the message to report when creating the envelope failed. Parameters:   request - The request. public  String getArea()      public  String getContext()      Returns the context, e.g. public  Document getDocument()      Returns the document or null if the current URL does not represent a document. public  DocumentFactory getDocumentFactory()      Returns the document factory. public  String getDocumentPath()      Returns the document-path. public  String getLanguage()      public  Publication getPublication()      Returns the publication of this PageEnvelope. public  RCEnvironment getRCEnvironment()      Returns the rcEnvironment. protected  void setContext(String string)      public  void setDocument(Document _document)      Sets the document. Field Detail AREA final public static String AREA(Code) AREA The area BREADCRUMB_PREFIX final public static String BREADCRUMB_PREFIX(Code) BREADCRUMB_PREFIX The breadcrumb prefix of the publication, used for navigation CONTEXT final public static String CONTEXT(Code) CONTEXT The context prefix DEFAULT_LANGUAGE final public static String DEFAULT_LANGUAGE(Code) DEFAULT_LANGUAGE The default language of the publication DEFAULT_PREFIX final public static String DEFAULT_PREFIX(Code) DEFAULT_PREFIX The default prefix DOCUMENT final public static String DOCUMENT(Code) DOCUMENT The current document DOCUMENT_EXTENSION final public static String DOCUMENT_EXTENSION(Code) DOCUMENT_EXTENSION The extension of the current document DOCUMENT_FILE final public static String DOCUMENT_FILE(Code) DOCUMENT_FILE The file of the current document DOCUMENT_ID final public static String DOCUMENT_ID(Code) DOCUMENT_ID The document id of the current document DOCUMENT_LABEL final public static String DOCUMENT_LABEL(Code) DOCUMENT_LABEL The label of the current document DOCUMENT_LANGUAGE final public static String DOCUMENT_LANGUAGE(Code) DOCUMENT_LANGUAGE The language of the current document DOCUMENT_LANGUAGES final public static String DOCUMENT_LANGUAGES(Code) DOCUMENT_LANGUAGES The languages the current document is available in DOCUMENT_LANGUAGES_CSV final public static String DOCUMENT_LANGUAGES_CSV(Code) DOCUMENT_LANGUAGES_CSV The languages the current document is available in, comma-seperated DOCUMENT_LASTMODIFIED final public static String DOCUMENT_LASTMODIFIED(Code) DOCUMENT_LASTMODIFIED The last modified date of the current document DOCUMENT_NAME final public static String DOCUMENT_NAME(Code) DOCUMENT_NAME The name of the current document DOCUMENT_PARENT final public static String DOCUMENT_PARENT(Code) DOCUMENT_PARENT The document id of the parent document DOCUMENT_PATH final public static String DOCUMENT_PATH(Code) DOCUMENT_PATH The path of the current document DOCUMENT_SOURCE_EXTENSION final public static String DOCUMENT_SOURCE_EXTENSION(Code) DOCUMENT_SOURCE_EXTENSION The source extension of the current document DOCUMENT_TYPE final public static String DOCUMENT_TYPE(Code) DOCUMENT_TYPE The type of the current document DOCUMENT_URL final public static String DOCUMENT_URL(Code) DOCUMENT_URL The URL of the current document DOCUMENT_URL_WITHOUT_LANGUAGE final public static String DOCUMENT_URL_WITHOUT_LANGUAGE(Code) DOCUMENT_URL_WITHOUT_LANGUAGE The URL of the current document without a language extension. DOCUMENT_UUID final public static String DOCUMENT_UUID(Code) DOCUMENT_UUID The uuid of the current document IS_PUBLICATION final public static String IS_PUBLICATION(Code) IS_PUBLICATION If the current URL refers to a publication ("true" or "false"). LANGUAGE final public static String LANGUAGE(Code) This attribute returns the document language if the document exists, or the default language otherwise. This makes it suitable for 404 pages. NAMESPACE final public static String NAMESPACE(Code) NAMESPACE The page envelope namespace PARAMETER_NAMES final public static String[] PARAMETER_NAMES(Code) The names of the page envelope parameters. PUBLICATION final public static String PUBLICATION(Code) PUBLICATION The publication PUBLICATION_ID final public static String PUBLICATION_ID(Code) PUBLICATION_ID The publication id PUBLICATION_LANGUAGES_CSV final public static String PUBLICATION_LANGUAGES_CSV(Code) PUBLICATION_LANGUAGES_CSV A list of the publication's languages, comma-seperated SSL_PREFIX final public static String SSL_PREFIX(Code) SSL_PREFIX The SSL prefix of the publication Constructor Detail PageEnvelope protected PageEnvelope()(Code) Constructor. PageEnvelope public PageEnvelope(DocumentFactory map, String contextPath, String webappUrl, File servletContext, Publication publication) throws PageEnvelopeException(Code) Creates a page envelope from an object model. Parameters:   map - The identity map to use. Parameters:   contextPath - The servlet context prefix. Parameters:   webappUrl - The web application URL. Parameters:   servletContext - The servlet context directory. Parameters:   publication - The publication. throws:   PageEnvelopeException - when something went wrong. Method Detail createExceptionMessage protected String createExceptionMessage(Request request)(Code) Creates the message to report when creating the envelope failed. Parameters:   request - The request. A string. getArea public String getArea()(Code) The current area. getContext public String getContext()(Code) Returns the context, e.g. "/lenya". a String value getDocument public Document getDocument()(Code) Returns the document or null if the current URL does not represent a document. A document getDocumentFactory public DocumentFactory getDocumentFactory()(Code) Returns the document factory. A document factory. getDocumentPath public String getDocumentPath()(Code) Returns the document-path. a File value getLanguage public String getLanguage()(Code) The document language or the default language if the document doesn't exist. See Also:   PageEnvelope.LANGUAGE getPublication public Publication getPublication()(Code) Returns the publication of this PageEnvelope. a Publication value getRCEnvironment public RCEnvironment getRCEnvironment()(Code) Returns the rcEnvironment. a RCEnvironment value setContext protected void setContext(String string)(Code) Parameters:   string - The context. setDocument public void setDocument(Document _document)(Code) Sets the document. Parameters:   _document - A document. Methods inherited from java.lang.Object native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc) public boolean equals(Object obj)(Code)(Java Doc) protected void finalize() throws Throwable(Code)(Java Doc) final native public Class getClass()(Code)(Java Doc) native public int hashCode()(Code)(Java Doc) final native public void notify()(Code)(Java Doc) final native public void notifyAll()(Code)(Java Doc) public String toString()(Code)(Java Doc) final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc) final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc) final public void wait() throws InterruptedException(Code)(Java Doc)