Menu
▾
▴
[Wonder-cvs] CVS: Wonder/Common/Frameworks/ERExtensions/Sources/er/extensions ERXComponent.java, NONE, 1.1 ERXWOContext.java, 1.31, 1.32 ERXAjaxApplication.java, 1.7, 1.8
|
From: Mike S. <ms...@us...> - 2007-11-09 04:33:23
|
Update of /cvsroot/wonder/Wonder/Common/Frameworks/ERExtensions/Sources/er/extensions In directory sc8-pr-cvs9.sourceforge.net:/tmp/cvs-serv22999/Sources/er/extensions Modified Files: ERXWOContext.java ERXAjaxApplication.java Added Files: ERXComponent.java Log Message: moved a bunch of utility methods into ERXWOContext and ERXAjaxApplication + added ERXComponent as a handy dandy baseclass for other components --- NEW FILE: ERXComponent.java --- package er.extensions; import com.webobjects.appserver.WOActionResults; import com.webobjects.appserver.WOComponent; import com.webobjects.appserver.WOContext; import com.webobjects.appserver.WORequest; import com.webobjects.appserver.WOResponse; import com.webobjects.foundation.NSArray; /** * ERXComponent provides a common baseclass for WOComponents along with a bunch * of miscellaneous handy features. * * @author mschrag */ public abstract class ERXComponent extends WOComponent { /** * Constructs a new ERXComponent. * * @param context * the WOContext */ public ERXComponent(WOContext context) { super(context); } /** * This variant of pageWithName provides a Java5 genericized version of the * original pageWithName. You would call it with: * * MyNextPage nextPage = pageWithName(MyNextPage.class); * * @param <T> * the type of component to create * @param componentClass * the Class of the component to load * @return an instance of the requested component class */ @SuppressWarnings("unchecked") public <T extends WOComponent> T pageWithName(Class<T> componentClass) { return (T) super.pageWithName(componentClass.getName()); } /** * _checkAccess is called prior to all three phases of the R-R loop to * ensure that the user has permission to access this component. You should * override checkAccess to implement addition security checks. * * @throws SecurityException * if the user does not have permission */ protected void _checkAccess() throws SecurityException { if (!isPageAccessAllowed() && _isPage()) { throw new SecurityException("You are not allowed to directly access the component '" + name() + "'."); } if (_isPage()) { checkAccess(); } } /** * Calls _checkAccess prior to super.takeValuesFromRequest. */ @Override public void takeValuesFromRequest(WORequest request, WOContext context) { _checkAccess(); super.takeValuesFromRequest(request, context); } /** * Calls _checkAccess prior to super.invokeAction. */ @Override public WOActionResults invokeAction(WORequest request, WOContext context) { _checkAccess(); return super.invokeAction(request, context); } /** * Calls _checkAccess prior to super.appendToResponse. */ @Override public void appendToResponse(WOResponse response, WOContext context) { _checkAccess(); preAppendToResponse(response, context); super.appendToResponse(response, context); postAppendToResponse(response, context); if (!ERXAjaxApplication.isAjaxRequest(context.request())) { _includeCSSResources(response, context); _includeJavascriptResources(response, context); } } /** * Returns the boolean value of a binding. * * @param component * the component * @param bindingName * the name of the boolean binding * @return a boolean */ protected boolean booleanValueForBinding(String bindingName) { return ERXComponentUtilities.booleanValueForBinding(this, bindingName); } /** * Returns the boolean value of a binding. * * @param component * the component * @param bindingName * the name of the boolean binding * @param defaultValue * the default value if the binding is null * @return a boolean */ protected boolean booleanValueForBinding(String bindingName, boolean defaultValue) { return ERXComponentUtilities.booleanValueForBinding(this, bindingName, defaultValue); } /** * Returns the name of this component without the package name. * * @return the name of this component without the package name */ public String componentName() { String componentName = name(); if (componentName != null) { int lastDotIndex = componentName.lastIndexOf('.'); if (lastDotIndex != -1) { componentName = componentName.substring(lastDotIndex + 1); } } return componentName; } /** * <p> * Injects per-component CSS dependencies into the head tag based on the * definitions in useDefaultComponentCSS(), defaultCSSPath(), * primaryCSSFile(), and additionalCSSFiles(). * </p> * <p> * If you return true for useDefaultComponentCSS (and do not override * primaryCSSFile), this component will inject a reference to * defaultCSSPath() + /YourComponentName.css. For instance, if your * component is named HeaderFooter, useDefaultComponentCSS will * automatically add a reference to defaultCSSPath() + /HeaderFooter.css for * you. This allows you to very easily specify per-component CSS files * without upper-level components knowing about them. Currently * _includeCSSResources does not try to do anything fancy in terms of * recombinding CSS files. * </p> * <p> * Override defaultCSSPath to provide the base path relative to * WebServerResources that contains your CSS files. If all of your CSS is in * WebServerResources/css, you would return "css" from defaultCSSPath(). * </p> * <p> * If you do not want to use the component's name as the name of the CSS * file, you can optionally override primaryCSSFile() to return the name of * a specific CSS file, as well as additionalCSSFiles() to return an NSArray * of CSS files. All of these file names will be prepended with the * defaultCSSPath if it is set. * </p> * * @param response * the response to write into * @param context * the current context */ protected void _includeCSSResources(WOResponse response, WOContext context) { String primaryCSSFile = primaryCSSFile(); if (primaryCSSFile == null && useDefaultComponentCSS()) { String componentName = componentName(); primaryCSSFile = componentName + ".css"; } if (primaryCSSFile != null) { String defaultCSSPath = defaultCSSPath(); if (defaultCSSPath != null && defaultCSSPath.length() > 0 && !defaultCSSPath.endsWith("/")) { defaultCSSPath += "/"; } String frameworkName = _frameworkName(); ERXWOContext.addStylesheetResourceInHead(context, response, frameworkName, defaultCSSPath + primaryCSSFile); } NSArray<String> additionalCSSFiles = additionalCSSFiles(); if (additionalCSSFiles != null) { String defaultCSSPath = defaultCSSPath(); if (defaultCSSPath != null && defaultCSSPath.length() > 0 && !defaultCSSPath.endsWith("/")) { defaultCSSPath += "/"; } String frameworkName = _frameworkName(); for (String additionalCSSFile : additionalCSSFiles) { ERXWOContext.addStylesheetResourceInHead(context, response, frameworkName, defaultCSSPath + additionalCSSFile); } } } /** * <p> * Injects per-component javascript dependencies into the head tag based on * the definitions in useDefaultComponentJavascript(), * defaultJavascriptPath(), primaryJavascriptFile(), and * additionalJavascriptFiles(). * </p> * <p> * If you return true for useDefaultComponentJavascript (and do not override * primaryJavascriptFile), this component will inject a reference to * defaultJavascriptPath() + /YourComponentName.js. For instance, if your * component is named HeaderFooter, useDefaultComponentJavascript will * automatically add a reference to defaultJavascriptPath() + * /HeaderFooter.js for you. This allows you to very easily specify * per-component Javascript files without upper-level components knowing * about them. Currently _includeJavascriptResources does not try to do * anything fancy in terms of recombinding Javascript files. * </p> * <p> * Override defaultJavascriptPath to provide the base path relative to * WebServerResources that contains your Javascript files. If all of your * Javascript is in WebServerResources/scripts, you would return "scripts" * from defaultJavascriptPath(). * </p> * <p> * If you do not want to use the component's name as the name of the * Javascript file, you can optionally override primaryJavascriptFile() to * return the name of a specific Javascript file, as well as * additionalJavascriptFiles() to return an NSArray of Javascript files. All * of these file names will be prepended with the defaultJavascriptPath if * it is set. * </p> * * @param response * the response to write into * @param context * the current context */ protected void _includeJavascriptResources(WOResponse response, WOContext context) { String primaryJavascriptFile = primaryJavascriptFile(); if (primaryJavascriptFile == null && useDefaultComponentJavascript()) { String componentName = componentName(); primaryJavascriptFile = componentName + ".js"; } if (primaryJavascriptFile != null) { String defaultJavascriptPath = defaultJavascriptPath(); if (defaultJavascriptPath != null && defaultJavascriptPath.length() > 0 && !defaultJavascriptPath.endsWith("/")) { defaultJavascriptPath += "/"; } String frameworkName = _frameworkName(); ERXWOContext.addScriptResourceInHead(context, response, frameworkName, defaultJavascriptPath + primaryJavascriptFile); } NSArray<String> additionalJavascriptFiles = additionalJavascriptFiles(); if (additionalJavascriptFiles != null) { String defaultJavascriptPath = defaultJavascriptPath(); if (defaultJavascriptPath != null && defaultJavascriptPath.length() > 0 && !defaultJavascriptPath.endsWith("/")) { defaultJavascriptPath += "/"; } String frameworkName = _frameworkName(); for (String additionalJavascriptFile : additionalJavascriptFiles) { ERXWOContext.addStylesheetResourceInHead(context, response, frameworkName, defaultJavascriptPath + additionalJavascriptFile); } } } /** * Returns the name of this component's framework or "app" if * frameworkName() returns null. * * @return the name of this component's framework */ protected String _frameworkName() { String frameworkName = super.frameworkName(); if (frameworkName == null) { frameworkName = "app"; } return frameworkName; } /** * Returns true if this component provides a default CSS file that has the * same name as the component itself. * * @return true if this component provides a default-named CSS */ protected boolean useDefaultComponentCSS() { return false; } /** * Returns the default path prefix for CSS, which will be prepended to all * required CSS files for this component. The default is "". * * @return the default CSS path. */ protected String defaultCSSPath() { return ""; } /** * Returns the primary CSS file for this component, or null if there isn't * one. This path will be prepended with defaultCSSPath(). * * @return the primary CSS file for this component */ protected String primaryCSSFile() { return null; } /** * Returns an array of additional CSS files for this component, or null (or * empty array) if there aren't any. Each path will be prepended with * defaultCSSPath(). * * @return an array of additional CSS files for this component. */ protected NSArray<String> additionalCSSFiles() { return null; } /** * Returns true if this component provides a default Javascript file that * has the same name as the component itself. * * @return true if this component provides a default-named Javascript */ protected boolean useDefaultComponentJavascript() { return false; } /** * Returns the default path prefix for Javascript, which will be prepended * to all required Javascript files for this component. The default is "". * * @return the default Javascript path. */ protected String defaultJavascriptPath() { return ""; } /** * Returns the primary Javascript file for this component, or null if there * isn't one. This path will be prepended with defaultJavascriptPath(). * * @return the primary Javascript file for this component */ protected String primaryJavascriptFile() { return null; } /** * Returns an array of additional Javascript files for this component, or * null (or empty array) if there aren't any. Each path will be prepended * with defaultJavascriptPath(). * * @return an array of additional Javascript files for this component. */ protected NSArray<String> additionalJavascriptFiles() { return null; } /** * Override and return true for any components to which you would like to * allow page level access. * * @return false by default */ protected boolean isPageAccessAllowed() { return false; } /** * Override to provide custom security checks. It is not necessary to call * super on this method. * * @throws SecurityException * if the security check fails */ protected void checkAccess() throws SecurityException { } /** * Override to hook into appendToResponse after security checks but before * the super.appendToResponse. It is not necessary to call super on this * method. * * @param response * the current response * @param context * the current context */ protected void preAppendToResponse(WOResponse response, WOContext context) { } /** * Override to hook into appendToResponse after super.appendToResponse. It * is not necessary to call super on this method. * * @param response * the current response * @param context * the current context */ protected void postAppendToResponse(WOResponse response, WOContext context) { } } Index: ERXWOContext.java =================================================================== RCS file: /cvsroot/wonder/Wonder/Common/Frameworks/ERExtensions/Sources/er/extensions/ERXWOContext.java,v retrieving revision 1.31 retrieving revision 1.32 diff -C2 -d -r1.31 -r1.32 *** ERXWOContext.java 29 Jul 2007 00:05:47 -0000 1.31 --- ERXWOContext.java 9 Nov 2007 04:33:11 -0000 1.32 *************** *** 90,99 **** } ! public void _generateCompleteURLs() { super._generateCompleteURLs(); _generateCompleteURLs = true; } ! public void _generateRelativeURLs() { super._generateRelativeURLs(); _generateCompleteURLs = false; --- 90,101 ---- } ! @Override ! public void _generateCompleteURLs() { super._generateCompleteURLs(); _generateCompleteURLs = true; } ! @Override ! public void _generateRelativeURLs() { super._generateRelativeURLs(); _generateCompleteURLs = false; *************** *** 120,124 **** } ! public String _urlWithRequestHandlerKey(String requestHandlerKey, String requestHandlerPath, String queryString, boolean secure) { String url = super._urlWithRequestHandlerKey(requestHandlerKey, requestHandlerPath, queryString, secure); url = ERXApplication.erxApplication()._rewriteURL(url); --- 122,127 ---- } ! @Override ! public String _urlWithRequestHandlerKey(String requestHandlerKey, String requestHandlerPath, String queryString, boolean secure) { String url = super._urlWithRequestHandlerKey(requestHandlerKey, requestHandlerPath, queryString, secure); url = ERXApplication.erxApplication()._rewriteURL(url); *************** *** 213,218 **** * @return */ ! public static NSArray componentPath(WOContext context) { ! NSMutableArray result = new NSMutableArray(); if (context != null) { WOComponent component = context.component(); --- 216,221 ---- * @return */ ! public static NSArray<String> componentPath(WOContext context) { ! NSMutableArray<String> result = new NSMutableArray<String>(); if (context != null) { WOComponent component = context.component(); *************** *** 274,277 **** --- 277,281 ---- } + @SuppressWarnings("unchecked") protected static void _insertInResponseBeforeTag(WOResponse response, String content, String tag, boolean appendIfTagMissing, boolean enqueueIfTagMissing) { String stream = response.contentString(); *************** *** 307,310 **** --- 311,380 ---- /** + * Adds a script tag with a correct resource url in the html head tag if it isn't already present in the response. + * + * @param context the context + * @param response the response + * @param framework the framework that contains the file + * @param fileName the name of the javascript file to add + */ + public static void addScriptResourceInHead(WOContext context, WOResponse response, String framework, String fileName) { + String startTag = "<script type=\"text/javascript\" src=\""; + String endTag = "\"></script>"; + ERXWOContext.addResourceInHead(context, response, framework, fileName, startTag, endTag); + } + + /** + * Adds a stylesheet link tag with a correct resource url in the html head tag if it isn't already present in the + * response. + * + * @param context the context + * @param response the response + * @param framework the framework that contains the file + * @param fileName the name of the css file to add + */ + public static void addStylesheetResourceInHead(WOContext context, WOResponse response, String framework, String fileName) { + String startTag = "<link rel = \"stylesheet\" type = \"text/css\" href = \""; + String endTag = "\"/>"; + ERXWOContext.addResourceInHead(context, response, framework, fileName, startTag, endTag); + } + + /** + * Adds javascript code in a script tag in the html head tag. + * + * @param response the response to write into + * @param script the javascript code to insert + */ + public static void addScriptCodeInHead(WOResponse response, String script) { + String js = "<script type=\"text/javascript\">\n" + script + "\n</script>"; + ERXWOContext.insertInResponseBeforeTag(response, js, ERXWOContext._htmlCloseHeadTag(), false, true); + } + + /** + * Returns a javascript-safe version of the given element ID. + * + * @param elementID the element ID + * @return a javascript-safe version (i.e. "wo_1_2_3_10") + */ + public static String toSafeElementID(String elementID) { + return "wo_" + elementID.replace('.', '_'); + } + + /** + * Adds a reference to an arbitrary file with a correct resource url wrapped between startTag and endTag in the html + * head tag if it isn't already present in the response. + * + * @param context the context + * @param response the response + * @param framework the framework that contains the file + * @param fileName the name of the file to add + * @param startTag the HTML to prepend before the URL + * @param endTag the HTML to append after the URL + */ + public static void addResourceInHead(WOContext context, WOResponse response, String framework, String fileName, String startTag, String endTag) { + boolean enqueueIfTagMissing = !ERXAjaxApplication.isAjaxRequest(context.request()); + ERXWOContext.addResourceInHead(context, response, framework, fileName, startTag, endTag, false, enqueueIfTagMissing); + } + + /** * Adds a reference to an arbitrary file with a correct resource url wrapped between startTag and endTag in the html * head tag if it isn't already present in the response. *************** *** 315,318 **** --- 385,389 ---- * @param endTag */ + @SuppressWarnings("unchecked") public static void addResourceInHead(WOContext context, WOResponse response, String framework, String fileName, String startTag, String endTag, boolean appendIfTagMissing, boolean enqueueIfTagMissing) { NSMutableDictionary userInfo = contextDictionary(); Index: ERXAjaxApplication.java =================================================================== RCS file: /cvsroot/wonder/Wonder/Common/Frameworks/ERExtensions/Sources/er/extensions/ERXAjaxApplication.java,v retrieving revision 1.7 retrieving revision 1.8 diff -C2 -d -r1.7 -r1.8 *** ERXAjaxApplication.java 13 Feb 2007 23:22:19 -0000 1.7 --- ERXAjaxApplication.java 9 Nov 2007 04:33:12 -0000 1.8 *************** *** 58,62 **** return shouldNotStorePage; } ! /** * Returns true if this is an ajax submit. --- 58,71 ---- return shouldNotStorePage; } ! ! /** ! * Return whether or not the given request is an Ajax request. ! * @param request the request the check ! */ ! public static boolean isAjaxRequest(WORequest request) { ! String requestedWith = request.headerForKey("x-requested-with"); ! return "XMLHttpRequest".equals(requestedWith); ! } ! /** * Returns true if this is an ajax submit. |