Skip to Content

Changes for page Click to Open

Last modified by Kieran Kelleher on 2012/07/21 20:41
From version 39.1
edited by chuckhill
on 2008/03/12 00:15
Change comment: There is no comment for this version
To version 37.1
edited by chuckhill
on 2008/03/12 14:32
Change comment: More edits

Summary

Details

Page properties
Content
... ... @@ -1,7 +1,13 @@
1 1  == What It Is ==
2 2  
3 -Click to Open is a browser based extension to WOLips. It provides a component that appears in the browser as part of the pages of your running application. Clicking on this, and then on an object in the browser window opens the relevant WOComponent in Eclipse. This makes life easier for UI designers and for developers getting familiar with new projects.
3 +C2O allows you to open components in Eclipse directly from the running application in your browser! Click to Open appears in the lower left corner of browser as part of the pages of your running application. Clicking on this component, and then on an object in the browser window, opens the relevant WOComponent in Eclipse. This makes life easier for UI designers and for developers getting familiar with new projects. It also provides some other very slick debugging tools.
4 4  
5 +Check out the [[screencast at the mDimension build site>>http://webobjects.mdimension.com/wolips/preview/WOLipsFramework.m4v]]!
6 +
7 +Click to Open is a browser based extension to WOLips found in [[Project Wonder>>WONDER:Home]]. All of the Wonder ERD2W components support this.
8 +
9 +**Note that click-to-open support is expensive, because it has to dig around your component HTML quite a bit, so you will take a performance hit in development to have it enabled.**
10 +
5 5  == What You Need ==
6 6  
7 7  You either need to be using Project Wonder or you need to get the **WOLips** framework that is part of Project Wonder. You can download it from [[mDimension's site>>http://webobjects.mdimension.com/wonder/]]. If not using Wonder, untar the frameworks and copy WOLips.framework to where you have the rest of your frameworks (usually /Library or ,,/Library).,,
... ... @@ -8,39 +8,70 @@
8 8  
9 9  == Getting Set Up ==
10 10  
11 -To fully utilize WOLips.framework, you must add support for click-to-open and you must provide
12 -a prototype.js implementation. Note that click-to-open support is expensive, because it has to dig around
13 -your component HTML quite a bit, so you will take a performance hit in development to have it enabled.
17 +=== Add the WOLips.framework ===
14 14  
15 -1) If your components extends ERXComponent, all you need to do is set:
19 +Follow the [[tutorial>>Add a Framework Dependency]] on adding a framework to add WOLips.framework to your application.
16 16  
17 - er.component.clickToOpen=true
21 +=== Add Support to Component Base Class ===
18 18  
19 -in your Properties file.
23 +If your components extend Wonder's ERXComponent, you can skip this step. Once again, using Wonder makes your life easier.
20 20  
21 -If you do not use ERXComponent and instead have a custom component base class, you must add
22 -clickToOpen support to your components on your own. You should ONLY have clickToOpen execute in your
23 -component if you are in development mode. To include it into your component base class, you can use
24 -the sample implementation from ERXComponent:
25 +If you don't have a custom component base class, you really should. Using com.webobjects.appserver.WOComponent as the super-class for your pages and components is just going to leave you doing the same things over and over.
25 25  
27 +You will need to add the appendToResponse(WOResponse, WOContext) method to your component base class, or add to it if you already have that method. You should ONLY have clickToOpen execute in your component if you are in development mode.
28 +
29 +To include it into your component base class, you can use this sample implementation:
30 +
26 26  {{code value="java"}}
27 27  
28 -@Override
29 -public void appendToResponse(WOResponse response, WOContext context) {
30 - ...
31 - boolean clickToOpenEnabled = ...;
32 - ERXClickToOpenSupport.preProcessResponse(response, context, clickToOpenEnabled);
33 +package net.com.foo.bar;
34 +
35 +import com.webobjects.appserver.*;
36 +import er.extensions.*;
37 +
38 +/**
39 + * Support for "Click to Open" navigation from the browser to the template in Eclipse. To enable this,
40 + * launch with:
41 + * <pre>
42 + * -Der.component.clickToOpen=true
43 + * </pre>
44 + */
45 +public class ClickToOpenComponent extends com.webobjects.appserver.WOComponent {
46 +
47 + public static final boolean isClickToOpenEnabled = ERXProperties.booleanForKeyWithDefault("er.component.clickToOpen", false);
48 +
49 + public ClickToOpenComponent(WOContext context) {
50 + super(context);
51 + }
52 +
53 + public void appendToResponse(WOResponse response, WOContext context) {
54 + ERXClickToOpenSupport.preProcessResponse(response, context, isClickToOpenEnabled);
55 + super.appendToResponse(response, context);
56 + ERXClickToOpenSupport.postProcessResponse(getClass(), response, context, isClickToOpenEnabled);
57 + }
58 +}
59 +
60 +{{/code}}
61 +
62 +For components that can't sub-class ClickToOpenComponent (directly or indirectly), you can enable Click to Open by adding this method to your component:
63 +
64 +{{code value="java"}}
65 +
66 +public void appendToResponse(WOResponse response, WOContext context)
67 +{
68 + ERXClickToOpenSupport.preProcessResponse(response, context, ClickToOpenComponent.isClickToOpenEnabled);
33 33   super.appendToResponse(response, context);
34 - ERXClickToOpenSupport.postProcessResponse(getClass(), response, context, clickToOpenEnabled);
35 - ...
70 + ERXClickToOpenSupport.postProcessResponse(getClass(), response, context, ClickToOpenComponent.isClickToOpenEnabled);
36 36  }
37 37  
38 38  {{/code}}
39 39  
40 -Note that when clickToOpenEnabled is false, the ERXClickToOpenSupport methods are no-ops.
75 +**Note that when isClickToOpenEnabled is false, the ERXClickToOpenSupport methods are no-ops.**
41 41  
42 -2) If your Application.java class does not extend ERXApplication, add a method like this:
77 +=== Add Support to Application ===
43 43  
79 +If your Application.java class extends Wonder's ERXApplication, you can skip this step too. Otherwise, add a developmentMode() method like this:
80 +
44 44  {{code value="java"}}
45 45  
46 46  private Boolean isDevelopmentMode;
... ... @@ -53,27 +53,67 @@
53 53  
54 54  {{/code}}
55 55  
56 -And add this to the launch arguments:
57 ---DdevelopmentMode=true--
93 +=== Set Application Properties ===
58 58  
59 -3) You must be using a recent version of WOLips that supports the WOLips Server. In
60 -your WOLips preferences, you must enable the WOLips Server, set the port number and the communication
61 -password. Turning on the WOLips Server requires a restart of WOLips.
95 +In your application's Properties file, add this line:
62 62  
63 -In your application preferences, you can then set:
97 +{{code}}
64 64  
65 - wolips.host=localhost
66 - wolips.port=9485
67 - wolips.password=yourpassword
68 -
69 -Only 'wolips.password' is strictly required as long as you use the default port of 9485.
99 +wolips.password=yourpassword
70 70  
71 -4) WOLips.framework needs a prototype.js. If you are using Ajax framework, you don't need to do
72 -anything, because it will default to use Ajax.framework's prototype.js. However, if you are not,
73 -you must set (as an example):
101 +{{/code}}
74 74  
75 - wolips.prototype.framework=app
76 - wolips.prototype.fileName=prototype.js
103 +If you need to, you can also change these default values:
77 77  
105 +{{code}}
106 +
107 +wolips.host=localhost
108 +wolips.port=9485
109 +
110 +{{/code}}
111 +
112 +=== Provide prototype.js ===
113 +
114 +WOLips.framework needs a prototype.js. If you are using Ajax framework, you don't need to do anything, because it will default to use Ajax.framework's prototype.js. However, if you are not, add this to your application's Properties file (as an example, change the values as appropriate):
115 +
116 +{{code}}
117 +
118 +wolips.prototype.framework=app
119 +wolips.prototype.fileName=prototype.js
120 +
121 +{{/code}}
122 +
123 +=== Add WOLToolBar to Your Pages ===
124 +
78 78  5) In your page wrapper, add a <wo:WOLToolBar/> component, and you're good to go. Look in the lower
79 79  left hand corner of the browser window for the link.
127 +
128 +=== Configure WOLips Server ===
129 +
130 +You must be using a recent version of WOLips that supports the WOLips Server. In
131 +your WOLips preferences, you must enable the WOLips Server, set the port number and the communication
132 +password. Turning on the WOLips Server requires a restart of WOLips.
133 +
134 +[[image:WOLipsServerPreferences.png]]
135 +
136 +=== Enable Click to Open ===
137 +
138 +And add this to the launch arguments:
139 +--DdevelopmentMode=true--
140 +
141 +[[image:EnableClickToOpen.png]]
142 +
143 +== Using Click to Open ==
144 +
145 +[[image:ClickToOpenLink.png]]
146 +
147 +[[image:ClickToOpenExpanded.png]]
148 +
149 +[[image:ClickToOpenInAction.png]]
150 +
151 +you can hold cmd
152 +and it will highlight the component
153 +and if you cmd-click
154 +it will popup the stack
155 +and you can pick from the stack
156 +also esc is a shortcut for getting out of click-to-open mode