Skip to Content

Changes for page Click to Open

Last modified by Kieran Kelleher on 2012/07/21 20:41
From version 59.1
edited by Pascal Robert
on 2012/07/21 20:41
Change comment: Migrated to Confluence 5.3
To version 57.1
edited by Pascal Robert
on 2012/07/21 20:41
Change comment: There is no comment for this version

Summary

Details

Page properties
Parent
... ... @@ -1,1 +1,0 @@
1 -WOLips Tutorials
Tags
... ... @@ -1,1 +1,0 @@
1 -clicktoopen|wolips|favourite
Content
... ... @@ -1,19 +1,15 @@
1 1  == What It Is ==
2 2  
3 -Click to Open (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.
3 +Click to Open (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>>url:http://webobjects.mdimension.com/wolips/support/screencasts/WOLipsFramework.m4v||shape="rect"]]
5 +Check out the [[screencast at the mDimension build site>>http://webobjects.mdimension.com/wolips/support/screencasts/WOLipsFramework.m4v]]
6 6  
7 -Click to Open is a browser based extension to WOLips found in [[Project Wonder>>doc:WONDER.Home]]. All of the Wonder ERD2W components support Click to Open.
7 +Click to Open is a browser based extension to WOLips found in [[Project Wonder>>WONDER:Home]]. All of the Wonder ERD2W components support Click to Open.
8 8  
9 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 10  
11 -*Also note that if you use ERExcelLook or ERPDFGeneration that you will want to disable Click to Open in development. The former you can do in a rule:
11 +Also note that if you use ERExcelLook or ERPDFGeneration that you will want to disable Click to Open in development. The former you can do in a rule: {{code}}*10 : pageConfiguration like '*Excel' => clickToOpenEnabled = "false" [com.webobjects.directtoweb.BooleanAssignment]{{/code}}
12 12  
13 -{{code}}
14 -*10 : pageConfiguration like '*Excel' => clickToOpenEnabled = "false" [com.webobjects.directtoweb.BooleanAssignment]
15 -{{/code}}
16 -
17 17  The latter in your component:
18 18  
19 19  {{code}}
... ... @@ -26,27 +26,27 @@
26 26  
27 27  == What You Need ==
28 28  
29 -You need the **WOLips** framework that is part of Project Wonder. You also need the **ERExtensions** framework that is part of Project Wonder on the class path at runtime. If you already use Project Wonder, you are almost done.
25 +You need the **WOLips** framework that is part of Project Wonder. You also need the **ERExtensions** framework that is part of Project Wonder on the class path at runtime. If you already use Project Wonder, you are almost done.
30 30  
31 -If you are not using Project Wonder, you can download it from [[mDimension's site>>url:http://webobjects.mdimension.com/wonder/||shape="rect"]], untar the frameworks, and copy just the WOLips.framework and ERExtensions.framework to where you have the rest of your frameworks (usually /Library/Frameworks or ~~/Library/Frameworks).
27 +If you are not using Project Wonder, you can download it from [[mDimension's site>>http://webobjects.mdimension.com/wonder/]], untar the frameworks, and copy just the WOLips.framework and ERExtensions.framework to where you have the rest of your frameworks (usually /Library/Frameworks or /Library/Frameworks).
32 32  
33 33  == Getting Set Up ==
34 34  
35 35  === Add the WOLips.framework ===
36 36  
37 -Follow the [[tutorial>>doc:Add a Framework Dependency]] on adding a framework to add WOLips.framework and ERXExtentions.framework to your application.
33 +Follow the [[tutorial>>Add a Framework Dependency]] on adding a framework to add WOLips.framework and ERXExtentions.framework to your application.
38 38  
39 39  === Add Support to Component Base Class ===
40 40  
41 -If your components extend Wonder's ERXComponent, you can skip this step. Once again, using Wonder makes your life easier.
37 +If your components extend Wonder's ERXComponent, you can skip this step. Once again, using Wonder makes your life easier.
42 42  
43 -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. If you don't have one, you might want to start using the ClickToOpenComponent below.
39 +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. If you don't have one, you might want to start using the ClickToOpenComponent below.
44 44  
45 45  You will need to add the appendToResponse(WOResponse, WOContext) method below to your component base class, or add this code to your appendToResponse method if you already have one.
46 46  
47 47  Here is an example implementation of a component base class and of Click to Open support:
48 48  
49 -{{code 0="java"}}
45 +{{code value="java"}}
50 50  
51 51  package net.com.foo.bar;
52 52  
... ... @@ -79,7 +79,7 @@
79 79  
80 80  For components that can't sub-class ClickToOpenComponent (directly or indirectly), you can enable Click to Open by adding this method to your component:
81 81  
82 -{{code 0="java"}}
78 +{{code value="java"}}
83 83  
84 84  public void appendToResponse(WOResponse response, WOContext context)
85 85  {
... ... @@ -94,9 +94,9 @@
94 94  
95 95  === Add Support to Application ===
96 96  
97 -If your Application.java class extends Wonder's ERXApplication, you can skip this step too. Otherwise, add a developmentMode() method like this:
93 +If your Application.java class extends Wonder's ERXApplication, you can skip this step too. Otherwise, add a developmentMode() method like this:
98 98  
99 -{{code 0="java"}}
95 +{{code value="java"}}
100 100  
101 101  private Boolean isDevelopmentMode;
102 102  public boolean developmentMode() {
... ... @@ -129,7 +129,7 @@
129 129  
130 130  === Provide prototype.js ===
131 131  
132 -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):
128 +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):
133 133  
134 134  {{code}}
135 135  
... ... @@ -142,17 +142,17 @@
142 142  
143 143  In your page wrapper's HTML template, add
144 144  
145 -{{code 0="html"}}
141 +{{code value="html"}}
146 146  
147 147  <wo:WOLToolBar/>
148 148  
149 149  {{/code}}
150 150  
151 -and you're done. If you don't have a [[page wrapper>>doc:Development-Examples-Page Layout]], you will have to add this to every page. Hint: page wrappers make your life easier.
147 +and you're done. If you don't have a [[page wrapper>>Development-Examples-Page Layout]], you will have to add this to every page. Hint: page wrappers make your life easier.
152 152  
153 153  If you are using the old WO template syntax, add this to the .html file:
154 154  
155 -{{code 0="html"}}
151 +{{code value="html"}}
156 156  
157 157  <webobject name="WOLToolBar" />
158 158  
... ... @@ -160,7 +160,7 @@
160 160  
161 161  And add this to the .wod file:
162 162  
163 -{{code 0="html"}}
159 +{{code value="html"}}
164 164  
165 165  WOLToolBar: WOLToolBar{
166 166  }
... ... @@ -169,13 +169,13 @@
169 169  
170 170  === Configure WOLips Server ===
171 171  
172 -You must be using a recent version of WOLips that supports the **WOLips Server**. In your WOLips preferences, you must enable the WOLips Server and set the communication password. This password must match the {{code language="none"}}wolips.password{{/code}} in the **Set Application Properties** section above.
168 +You must be using a recent version of WOLips that supports the **WOLips Server**. In your WOLips preferences, you must enable the WOLips Server and set the communication password. This password must match the ##wolips.password## in the **Set Application Properties** section above.
173 173  
174 174  **Turning on the WOLips Server requires Eclipse to be restarted.**
175 175  
176 -[[image:attach:WOLipsServerPreferences.png]]
172 +[[image:WOLipsServerPreferences.png]]
177 177  
178 -You can optionally change the port number. If you do change the port number, see {{code language="none"}}wolips.port{{/code}} in the **Set Application Properties** section above.
174 +You can optionally change the port number. If you do change the port number, see ##wolips.port## in the **Set Application Properties** section above.
179 179  
180 180  === Enable Click to Open ===
181 181  
... ... @@ -186,32 +186,32 @@
186 186  
187 187  If you are not using Wonder, add the Launch parameters as follows:
188 188  
189 -* Parameter = **-Der.component.clickToOpen=true**, Argument = **true**
190 -* Parameter = **-Der.extensions.ERXApplication.developmentMode=true** Argument = **true**
185 +* Parameter = **Der.component.clickToOpen=true**, Argument = **true**
186 +* Parameter = **Der.extensions.ERXApplication.developmentMode=true** Argument = **true**
191 191  
192 -[[image:attach:EnableClickToOpen.png]]
188 +[[image:EnableClickToOpen.png]]
193 193  
194 194  == Using Click to Open ==
195 195  
196 -Run your application and look in the lower, left hand corner. You should see a link like this:
192 +Run your application and look in the lower, left hand corner. You should see a link like this:
197 197  
198 -[[image:attach:ClickToOpenLink.png]]
194 +[[image:ClickToOpenLink.png]]
199 199  
200 -If you don't, check that the page has the WOLToolBar on it and that the {{code language="none"}}er.component.clickToOpen{{/code}} property is set to true and the {{code language="none"}}er.extensions.ERXApplication.developmentMode{{/code}} property is set to true.
196 +If you don't, check that the page has the WOLToolBar on it and that the ##er.component.clickToOpen## property is set to true and the ##er.extensions.ERXApplication.developmentMode## property is set to true.
201 201  
202 202  \\
203 203  
204 204  Click on this component to open the Click to Open UI:
205 205  
206 -[[image:attach:WOLipsToolbar.png]]
202 +[[image:WOLipsToolbar.png]]
207 207  
208 -**EditDisplayAd** is the page in the browser. Click on this link to open this page in Eclipse.
204 +**EditDisplayAd** is the page in the browser. Click on this link to open this page in Eclipse.
209 209  
210 210  \\
211 211  
212 -If you are looking for a sub-component of this page, click on the **Click to Open** link. As you move your mouse over the page, the bread crumb of components will change to show you where you are. Just click to open the component under the mouse in Eclipse. It is that easy!
208 +If you are looking for a sub-component of this page, click on the **Click to Open** link. As you move your mouse over the page, the bread crumb of components will change to show you where you are. Just click to open the component under the mouse in Eclipse. It is that easy
213 213  
214 -[[image:attach:ClickToOpenInAction.png]]
210 +[[image:ClickToOpenInAction.png]]
215 215  
216 216  \\
217 217  
... ... @@ -220,5 +220,5 @@
220 220  * Esc is a shortcut for getting out of click-to-open mode
221 221  * hold down the Cmd key while you move the mouse around and it will highlight the component
222 222  * Cmd-click it will popup the stack of components and you can pick from the stack:
223 -[[image:attach:ComponentStack.png]]
224 -* you can set the binding {{code language="none"}}expanded=true;{{/code}} on WOLToolBar so it's open by default, instead of closed
219 +[[image:ComponentStack.png]]
220 +* you can set the binding ##expanded=true;## on WOLToolBar so it's open by default, instead of closed
ClickToOpenExpanded.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.XWikiGuest
Size
... ... @@ -1,1 +1,0 @@
1 -7.4 KB
Content
ClickToOpenInAction.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.XWikiGuest
Size
... ... @@ -1,1 +1,0 @@
1 -17.9 KB
Content
ClickToOpenLink.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.XWikiGuest
Size
... ... @@ -1,1 +1,0 @@
1 -4.9 KB
Content
ComponentStack.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.XWikiGuest
Size
... ... @@ -1,1 +1,0 @@
1 -14.8 KB
Content
EnableClickToOpen.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.XWikiGuest
Size
... ... @@ -1,1 +1,0 @@
1 -54.1 KB
Content
WOLipsServerPreferences.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.XWikiGuest
Size
... ... @@ -1,1 +1,0 @@
1 -35.8 KB
Content
WOLipsToolbar.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.XWikiGuest
Size
... ... @@ -1,1 +1,0 @@
1 -4.2 KB
Content