Skip to Content

Wiki source code of Click to Open

Version 37.1 by chuckhill on 2008/03/12 14:32
Show last authors
1 == What It Is ==
2
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
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
11 == What You Need ==
12
13 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).,,
14
15 == Getting Set Up ==
16
17 === Add the WOLips.framework ===
18
19 Follow the [[tutorial>>Add a Framework Dependency]] on adding a framework to add WOLips.framework to your application.
20
21 === Add Support to Component Base Class ===
22
23 If your components extend Wonder's ERXComponent, you can skip this step. Once again, using Wonder makes your life easier.
24
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.
26
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
31 {{code value="java"}}
32
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);
69 super.appendToResponse(response, context);
70 ERXClickToOpenSupport.postProcessResponse(getClass(), response, context, ClickToOpenComponent.isClickToOpenEnabled);
71 }
72
73 {{/code}}
74
75 **Note that when isClickToOpenEnabled is false, the ERXClickToOpenSupport methods are no-ops.**
76
77 === Add Support to Application ===
78
79 If your Application.java class extends Wonder's ERXApplication, you can skip this step too. Otherwise, add a developmentMode() method like this:
80
81 {{code value="java"}}
82
83 private Boolean isDevelopmentMode;
84 public boolean developmentMode() {
85 if (isDevelopmentMode == null) {
86 isDevelopmentMode = new Boolean(ERXProperties.booleanForKey("developmentMode", false));
87 }
88 return isDevelopmentMode.booleanValue();
89 }
90
91 {{/code}}
92
93 === Set Application Properties ===
94
95 In your application's Properties file, add this line:
96
97 {{code}}
98
99 wolips.password=yourpassword
100
101 {{/code}}
102
103 If you need to, you can also change these default values:
104
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
125 5) In your page wrapper, add a <wo:WOLToolBar/> component, and you're good to go. Look in the lower
126 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