Skip to Content

Wiki source code of Create a new WO Component

Version 3.1 by Mike Schrag on 2005/09/26 00:13
Show last authors
1 Let's add a new WO Component to our project.
2
3 1. Right-Click/Ctrl-Click on the project and select "New" => "WOComponent"
4 \\\\[[image:Picture 25.png]]
5 \\
6
7 ----
8
9 \\
10
11 1. The "New WebObjects Component" dialog opens. The only required field is the WOComponent name. Let's just use the default "MyComponent" as the component name. I generally deselect "Create body tag" and "Create api file", but you can leave them if you'd like. Click "Finish" to continue.
12 \\\\[[image:Picture 26.png]]
13 \\
14
15 ----
16
17 \\
18
19 1. You should now have a new MyComponent.java in your source folder, a MyComponent.wo folder at the project root (or whereever you decide to add the component), a wod, woo, html, and optional api file, and the Component Editor should now open to show your new component.
20 \\\\[[image:Picture 27.png]]
21 \\
22
23 ----
24
25 \\
26
27 1. Switch to the "Java" tab and add the "greeting" method as defined in the picture below and save.
28 \\\\[[image:Picture 28.png]]
29 \\
30
31 ----
32
33 \\
34
35 1. Now switch to the "Component" tab, add a <webobject> tag in the HTML and save, then the WOD definition and save. Note that you must save each of the editors individually for changes to be visible ~-~- even in the split view. If your file is unsaved, you will see a "**" next to the filename in the tab at the top of the editor.
36 \\\\[[image:Picture 29.png]]
37 \\**
38
39 ----
40
41 \\
42
43 1. Now switch to your Main.wo Component Editor "Component" tab and add a <webobject> tag named "Greeting" and save. Switch to the WOD editor and add a Greeting element that is of type "MyComponent" (you'll notice that code completion now shows MyComponent in the list, because it is a subclass of WOElement).
44 \\\\[[image:Picture 30.png]]
45 \\
46
47 ----
48
49 \\
50
51 1. Adding a new Java file technically is not a violation of Hot Code Replacement, however, WO seems to not like a new HTML template appearing in your bundle that it doesn't know about. So go ahead and stop your app if it's running and then re-debug it (from the previous instructions). You should now have a "Hello!" in Main.wo is generated by the embedded MyComponent component.
52 \\\\[[image:Picture 31.png]]
53 \\
54
55 ----
56
57 \\
58
59 1. Continue on to see how to [[Add a Framework Dependency]] to your project.