From 83951890bc4c490d6b691c032092862251e445d9 Mon Sep 17 00:00:00 2001 From: Jani Laakso Date: Fri, 9 Feb 2007 17:23:24 +0000 Subject: [PATCH] Javadoc now has content. Fixed #336 (FeatureBrowser: Javadoc tabs are empty) svn changeset:618/svn branch:toolkit --- .../itmill/toolkit/demo/features/Feature.java | 26 ++++++++++++++----- .../demo/features/FeatureBuffering.java | 2 ++ .../toolkit/demo/features/FeatureButton.java | 2 ++ .../demo/features/FeatureContainers.java | 2 ++ .../demo/features/FeatureCustomLayout.java | 2 ++ .../demo/features/FeatureDateField.java | 2 ++ .../demo/features/FeatureEmbedded.java | 2 ++ .../toolkit/demo/features/FeatureForm.java | 2 ++ .../demo/features/FeatureFrameWindow.java | 2 ++ .../demo/features/FeatureGridLayout.java | 2 ++ .../toolkit/demo/features/FeatureItems.java | 2 ++ .../toolkit/demo/features/FeatureLabel.java | 2 ++ .../toolkit/demo/features/FeatureLink.java | 2 ++ .../demo/features/FeatureOrderedLayout.java | 2 ++ .../toolkit/demo/features/FeaturePanel.java | 2 ++ .../demo/features/FeatureProperties.java | 2 ++ .../toolkit/demo/features/FeatureSelect.java | 2 ++ .../demo/features/FeatureTabSheet.java | 2 ++ .../toolkit/demo/features/FeatureTable.java | 3 +++ .../demo/features/FeatureTextField.java | 4 ++- .../toolkit/demo/features/FeatureTree.java | 4 ++- .../toolkit/demo/features/FeatureUpload.java | 2 ++ .../demo/features/FeatureValidators.java | 2 ++ .../toolkit/demo/features/FeatureWindow.java | 4 ++- .../toolkit/demo/features/IntroBasic.java | 4 ++- .../demo/features/IntroComponents.java | 4 ++- .../toolkit/demo/features/IntroWelcome.java | 4 ++- 27 files changed, 78 insertions(+), 13 deletions(-) diff --git a/src/com/itmill/toolkit/demo/features/Feature.java b/src/com/itmill/toolkit/demo/features/Feature.java index e7d9083f12..c59eeb30ab 100644 --- a/src/com/itmill/toolkit/demo/features/Feature.java +++ b/src/com/itmill/toolkit/demo/features/Feature.java @@ -44,11 +44,21 @@ public abstract class Feature extends CustomComponent { protected PropertyPanel propertyPanel; + private Label javadoc; + /** Constuctor for the feature component */ public Feature() { layout = new OrderedLayout(OrderedLayout.ORIENTATION_VERTICAL); setCompositionRoot(layout); } + + /** + * Actual URL consists of "/doc/api/com/itmill/toolkit/"+url + * @param url + */ + public void setJavadocURL(String url) { + javadoc.setValue(""); + } /** * Feature component initialization is lazily done when the feature is @@ -62,6 +72,10 @@ public abstract class Feature extends CustomComponent { if (initialized) return; initialized = true; + + // Javadoc + javadoc = new Label(); + javadoc.setContentMode(Label.CONTENT_RAW); // Demo Component demo = getDemoComponent(); @@ -71,7 +85,7 @@ public abstract class Feature extends CustomComponent { ts = new TabSheet(); layout.addComponent(ts); - // Description + // Description tab String desc = getDescriptionXHTML(); String title = getTitle(); if (desc != null && title != null) { @@ -84,7 +98,7 @@ public abstract class Feature extends CustomComponent { ts.addTab(gl, "Description", null); } - // Code Sample + // Code Sample tab String example = getExampleSrc(); if (example != null) { OrderedLayout l = new OrderedLayout(); @@ -93,11 +107,9 @@ public abstract class Feature extends CustomComponent { l.addComponent(new Label(example, Label.CONTENT_PREFORMATTED)); ts.addTab(l, "Code Sample", null); } - - // Javadoc - Label javadocPlaceholder = new Label( - "This is a placeholder for Javadoc"); - ts.addTab(javadocPlaceholder, "Javadoc", null); + + // Javadoc tab + ts.addTab(javadoc, "Javadoc", null); // Properties tab // if (properties != null) diff --git a/src/com/itmill/toolkit/demo/features/FeatureBuffering.java b/src/com/itmill/toolkit/demo/features/FeatureBuffering.java index 3a37bc88f6..3071c3a3d6 100644 --- a/src/com/itmill/toolkit/demo/features/FeatureBuffering.java +++ b/src/com/itmill/toolkit/demo/features/FeatureBuffering.java @@ -49,6 +49,8 @@ public class FeatureBuffering extends Feature { // Properties propertyPanel = null; + setJavadocURL("data/Buffered.html"); + return l; } diff --git a/src/com/itmill/toolkit/demo/features/FeatureButton.java b/src/com/itmill/toolkit/demo/features/FeatureButton.java index 8a9e54ff61..364e759b6e 100644 --- a/src/com/itmill/toolkit/demo/features/FeatureButton.java +++ b/src/com/itmill/toolkit/demo/features/FeatureButton.java @@ -52,6 +52,8 @@ public class FeatureButton extends Feature { .createBeanPropertySet(new String[] { "switchMode" }); propertyPanel.addProperties("Button Properties", ap); + setJavadocURL("ui/Button.html"); + return l; } diff --git a/src/com/itmill/toolkit/demo/features/FeatureContainers.java b/src/com/itmill/toolkit/demo/features/FeatureContainers.java index 69950319b6..94d093ae56 100644 --- a/src/com/itmill/toolkit/demo/features/FeatureContainers.java +++ b/src/com/itmill/toolkit/demo/features/FeatureContainers.java @@ -49,6 +49,8 @@ public class FeatureContainers extends Feature { // Properties propertyPanel = null; + setJavadocURL("data/Container.html"); + return l; } diff --git a/src/com/itmill/toolkit/demo/features/FeatureCustomLayout.java b/src/com/itmill/toolkit/demo/features/FeatureCustomLayout.java index bd9b605886..a9900e4b63 100644 --- a/src/com/itmill/toolkit/demo/features/FeatureCustomLayout.java +++ b/src/com/itmill/toolkit/demo/features/FeatureCustomLayout.java @@ -70,6 +70,8 @@ public class FeatureCustomLayout extends Feature { // Properties propertyPanel = null; + + setJavadocURL("ui/CustomLayout.html"); return l; } diff --git a/src/com/itmill/toolkit/demo/features/FeatureDateField.java b/src/com/itmill/toolkit/demo/features/FeatureDateField.java index 314e3ae900..30b7644857 100644 --- a/src/com/itmill/toolkit/demo/features/FeatureDateField.java +++ b/src/com/itmill/toolkit/demo/features/FeatureDateField.java @@ -92,6 +92,8 @@ public class FeatureDateField extends Feature { themes.addItem("calendar").getItemProperty( themes.getItemCaptionPropertyId()).setValue("calendar"); propertyPanel.addProperties("DateField Properties", ap); + + setJavadocURL("ui/DateField"); return l; } diff --git a/src/com/itmill/toolkit/demo/features/FeatureEmbedded.java b/src/com/itmill/toolkit/demo/features/FeatureEmbedded.java index d3c5fc0bf0..bb54d345ea 100644 --- a/src/com/itmill/toolkit/demo/features/FeatureEmbedded.java +++ b/src/com/itmill/toolkit/demo/features/FeatureEmbedded.java @@ -89,6 +89,8 @@ public class FeatureEmbedded extends Feature { .setDescription( "Unique object id. This can be used for example to identify windows components."); + setJavadocURL("ui/Embedded.html"); + return l; } diff --git a/src/com/itmill/toolkit/demo/features/FeatureForm.java b/src/com/itmill/toolkit/demo/features/FeatureForm.java index ab3af0db55..4e0fda7c85 100644 --- a/src/com/itmill/toolkit/demo/features/FeatureForm.java +++ b/src/com/itmill/toolkit/demo/features/FeatureForm.java @@ -52,6 +52,8 @@ public class FeatureForm extends Feature implements demo = new OrderedLayout(); createDemo(); } + + setJavadocURL("ui/Form.html"); return demo; } diff --git a/src/com/itmill/toolkit/demo/features/FeatureFrameWindow.java b/src/com/itmill/toolkit/demo/features/FeatureFrameWindow.java index 493ae4ecc8..fa60495edb 100644 --- a/src/com/itmill/toolkit/demo/features/FeatureFrameWindow.java +++ b/src/com/itmill/toolkit/demo/features/FeatureFrameWindow.java @@ -70,6 +70,8 @@ public class FeatureFrameWindow extends Feature implements Button.ClickListener "None", "Minimal" }); propertyPanel.addProperties("FrameWindow Properties", ap); + + setJavadocURL("ui/FrameWindow.html"); return l; } diff --git a/src/com/itmill/toolkit/demo/features/FeatureGridLayout.java b/src/com/itmill/toolkit/demo/features/FeatureGridLayout.java index 46f12821fa..134de073f8 100644 --- a/src/com/itmill/toolkit/demo/features/FeatureGridLayout.java +++ b/src/com/itmill/toolkit/demo/features/FeatureGridLayout.java @@ -59,6 +59,8 @@ public class FeatureGridLayout extends Feature { propertyPanel.addProperties("GridLayout Features", ap); propertyPanel.getField("height").dependsOn( propertyPanel.getField("add component")); + + setJavadocURL("ui/GridLayout.html"); return l; } diff --git a/src/com/itmill/toolkit/demo/features/FeatureItems.java b/src/com/itmill/toolkit/demo/features/FeatureItems.java index fb9b92b24f..208fccd2d9 100644 --- a/src/com/itmill/toolkit/demo/features/FeatureItems.java +++ b/src/com/itmill/toolkit/demo/features/FeatureItems.java @@ -49,6 +49,8 @@ public class FeatureItems extends Feature { // Properties propertyPanel = null; + setJavadocURL("data/Items.html"); + return l; } diff --git a/src/com/itmill/toolkit/demo/features/FeatureLabel.java b/src/com/itmill/toolkit/demo/features/FeatureLabel.java index 829318b57d..88e5448ec2 100644 --- a/src/com/itmill/toolkit/demo/features/FeatureLabel.java +++ b/src/com/itmill/toolkit/demo/features/FeatureLabel.java @@ -58,6 +58,8 @@ public class FeatureLabel extends Feature { "XML (Subtree with namespace)" }); propertyPanel.addProperties("Label Properties", ap); + setJavadocURL("ui/Label.html"); + return l; } diff --git a/src/com/itmill/toolkit/demo/features/FeatureLink.java b/src/com/itmill/toolkit/demo/features/FeatureLink.java index bdcd9a40e6..b1b3a52b7a 100644 --- a/src/com/itmill/toolkit/demo/features/FeatureLink.java +++ b/src/com/itmill/toolkit/demo/features/FeatureLink.java @@ -56,6 +56,8 @@ public class FeatureLink extends Feature { "Default", "Minimal", "None" }); propertyPanel.addProperties("Link Properties", ap); + setJavadocURL("ui/Link.html"); + return l; } diff --git a/src/com/itmill/toolkit/demo/features/FeatureOrderedLayout.java b/src/com/itmill/toolkit/demo/features/FeatureOrderedLayout.java index 064bdaefee..3b006e5e86 100644 --- a/src/com/itmill/toolkit/demo/features/FeatureOrderedLayout.java +++ b/src/com/itmill/toolkit/demo/features/FeatureOrderedLayout.java @@ -58,6 +58,8 @@ public class FeatureOrderedLayout extends Feature { themes.getItemCaptionPropertyId()).setValue("form"); propertyPanel.addProperties("OrderedLayout Properties", ap); + setJavadocURL("ui/OrderedLayout.html"); + return l; } diff --git a/src/com/itmill/toolkit/demo/features/FeaturePanel.java b/src/com/itmill/toolkit/demo/features/FeaturePanel.java index 6379dd370d..199203be02 100644 --- a/src/com/itmill/toolkit/demo/features/FeaturePanel.java +++ b/src/com/itmill/toolkit/demo/features/FeaturePanel.java @@ -56,6 +56,8 @@ public class FeaturePanel extends Feature { themes.getItemCaptionPropertyId()).setValue("strong"); propertyPanel.addProperties("Panel Properties", ap); + setJavadocURL("ui/Panel.html"); + return l; } diff --git a/src/com/itmill/toolkit/demo/features/FeatureProperties.java b/src/com/itmill/toolkit/demo/features/FeatureProperties.java index 22455d92da..253c20356f 100644 --- a/src/com/itmill/toolkit/demo/features/FeatureProperties.java +++ b/src/com/itmill/toolkit/demo/features/FeatureProperties.java @@ -49,6 +49,8 @@ public class FeatureProperties extends Feature { // Properties propertyPanel = null; + setJavadocURL("ui/package-summary.html"); + return l; } diff --git a/src/com/itmill/toolkit/demo/features/FeatureSelect.java b/src/com/itmill/toolkit/demo/features/FeatureSelect.java index aa13823be8..53d883797a 100644 --- a/src/com/itmill/toolkit/demo/features/FeatureSelect.java +++ b/src/com/itmill/toolkit/demo/features/FeatureSelect.java @@ -65,6 +65,8 @@ public class FeatureSelect extends Feature { themes.getItemCaptionPropertyId()).setValue("optiongroup"); themes.addItem("twincol").getItemProperty( themes.getItemCaptionPropertyId()).setValue("twincol"); + + setJavadocURL("ui/Select.html"); return l; } diff --git a/src/com/itmill/toolkit/demo/features/FeatureTabSheet.java b/src/com/itmill/toolkit/demo/features/FeatureTabSheet.java index 9cc5419ce8..19bf0399be 100644 --- a/src/com/itmill/toolkit/demo/features/FeatureTabSheet.java +++ b/src/com/itmill/toolkit/demo/features/FeatureTabSheet.java @@ -48,6 +48,8 @@ public class FeatureTabSheet extends Feature { // Properties propertyPanel = new PropertyPanel(ts); + + setJavadocURL("ui/TabSheet.html"); return l; } diff --git a/src/com/itmill/toolkit/demo/features/FeatureTable.java b/src/com/itmill/toolkit/demo/features/FeatureTable.java index 27fcfd45b0..06c97329fa 100644 --- a/src/com/itmill/toolkit/demo/features/FeatureTable.java +++ b/src/com/itmill/toolkit/demo/features/FeatureTable.java @@ -32,6 +32,7 @@ import com.itmill.toolkit.event.Action; import com.itmill.toolkit.ui.Button; import com.itmill.toolkit.ui.Component; import com.itmill.toolkit.ui.Form; +import com.itmill.toolkit.ui.Label; import com.itmill.toolkit.ui.OrderedLayout; import com.itmill.toolkit.ui.Select; import com.itmill.toolkit.ui.Table; @@ -140,6 +141,8 @@ public class FeatureTable extends Feature implements Action.Handler { t.setColumnReorderingAllowed(true); t.setSelectable(true); + setJavadocURL("ui/Table.html"); + return l; } diff --git a/src/com/itmill/toolkit/demo/features/FeatureTextField.java b/src/com/itmill/toolkit/demo/features/FeatureTextField.java index 4e8ded17b5..0485b9d8fa 100644 --- a/src/com/itmill/toolkit/demo/features/FeatureTextField.java +++ b/src/com/itmill/toolkit/demo/features/FeatureTextField.java @@ -51,7 +51,9 @@ public class FeatureTextField extends Feature { "rows", "wordwrap", "writeThrough", "readThrough", "nullRepresentation", "nullSettingAllowed", "secret" }); propertyPanel.addProperties("Text field properties", f); - + + setJavadocURL("ui/TextField.html"); + return l; } diff --git a/src/com/itmill/toolkit/demo/features/FeatureTree.java b/src/com/itmill/toolkit/demo/features/FeatureTree.java index 8dff405a4b..fa82a6852b 100644 --- a/src/com/itmill/toolkit/demo/features/FeatureTree.java +++ b/src/com/itmill/toolkit/demo/features/FeatureTree.java @@ -118,7 +118,9 @@ public class FeatureTree extends Feature implements Action.Handler { themes.addItem("menu").getItemProperty( themes.getItemCaptionPropertyId()).setValue("menu"); propertyPanel.addProperties("Tree Properties", ap); - + + setJavadocURL("ui/Tree.html"); + return l; } diff --git a/src/com/itmill/toolkit/demo/features/FeatureUpload.java b/src/com/itmill/toolkit/demo/features/FeatureUpload.java index 7e391ea4ac..e4d90ecd01 100644 --- a/src/com/itmill/toolkit/demo/features/FeatureUpload.java +++ b/src/com/itmill/toolkit/demo/features/FeatureUpload.java @@ -65,6 +65,8 @@ public class FeatureUpload extends Feature implements Upload.FinishedListener { // Properties propertyPanel = new PropertyPanel(up); + + setJavadocURL("ui/Upload.html"); return l; } diff --git a/src/com/itmill/toolkit/demo/features/FeatureValidators.java b/src/com/itmill/toolkit/demo/features/FeatureValidators.java index c6f70a5598..ce469c0e9c 100644 --- a/src/com/itmill/toolkit/demo/features/FeatureValidators.java +++ b/src/com/itmill/toolkit/demo/features/FeatureValidators.java @@ -49,6 +49,8 @@ public class FeatureValidators extends Feature { // Properties propertyPanel = null; + setJavadocURL("data/Validator.html"); + return l; } diff --git a/src/com/itmill/toolkit/demo/features/FeatureWindow.java b/src/com/itmill/toolkit/demo/features/FeatureWindow.java index a7e2e22381..32fd71d529 100644 --- a/src/com/itmill/toolkit/demo/features/FeatureWindow.java +++ b/src/com/itmill/toolkit/demo/features/FeatureWindow.java @@ -65,7 +65,9 @@ public class FeatureWindow extends Feature { new Integer(Window.BORDER_MINIMAL) }, new Object[] { "Default", "None", "Minimal" }); propertyPanel.addProperties("Window Properties", windowProperties); - + + setJavadocURL("ui/Window.html"); + return l; } diff --git a/src/com/itmill/toolkit/demo/features/IntroBasic.java b/src/com/itmill/toolkit/demo/features/IntroBasic.java index 4c76a16445..5501a7c968 100644 --- a/src/com/itmill/toolkit/demo/features/IntroBasic.java +++ b/src/com/itmill/toolkit/demo/features/IntroBasic.java @@ -45,10 +45,12 @@ public class IntroBasic extends Feature { Label lab = new Label(); lab.setStyle("featurebrowser-none"); l.addComponent(lab); - + // Properties propertyPanel = null; + setJavadocURL("ui/package-summary.html"); + return l; } diff --git a/src/com/itmill/toolkit/demo/features/IntroComponents.java b/src/com/itmill/toolkit/demo/features/IntroComponents.java index b7cf2412d4..966c5f818c 100644 --- a/src/com/itmill/toolkit/demo/features/IntroComponents.java +++ b/src/com/itmill/toolkit/demo/features/IntroComponents.java @@ -48,7 +48,9 @@ public class IntroComponents extends Feature { // Properties propertyPanel = null; - + + setJavadocURL("ui/package-summary.html"); + return l; } diff --git a/src/com/itmill/toolkit/demo/features/IntroWelcome.java b/src/com/itmill/toolkit/demo/features/IntroWelcome.java index 3346f97269..94277e5f58 100644 --- a/src/com/itmill/toolkit/demo/features/IntroWelcome.java +++ b/src/com/itmill/toolkit/demo/features/IntroWelcome.java @@ -60,7 +60,9 @@ public class IntroWelcome extends Feature { // Properties propertyPanel = null; - + + setJavadocURL("package-summary.html"); + return l; } -- 2.39.5