anmolbabu has uploaded a new change for review. Change subject: webadmin : Added Javadoc to CheckBoxGroup and DaysOfMonthSelector ......................................................................
webadmin : Added Javadoc to CheckBoxGroup and DaysOfMonthSelector This patch adds JavaDocs to the newly added widgets 1. CheckBoxGroup 2. DaysOfMonthSelector created as part of the patch set : https://gerrit.ovirt.org/#/c/37302/ Change-Id: I46d9189dcb1fb2f7d80321488a06d2dd67386e78 Signed-off-by: Anmol Babu <anb...@redhat.com> --- M frontend/webadmin/modules/gwt-common/src/main/java/org/ovirt/engine/ui/common/widget/editor/CheckBoxGroup.java M frontend/webadmin/modules/gwt-common/src/main/java/org/ovirt/engine/ui/common/widget/editor/DaysOfMonthSelector.java M frontend/webadmin/modules/gwt-common/src/main/java/org/ovirt/engine/ui/common/widget/editor/ListModelCheckBoxGroup.java M frontend/webadmin/modules/gwt-common/src/main/java/org/ovirt/engine/ui/common/widget/editor/ListModelCheckBoxGroupEditor.java M frontend/webadmin/modules/gwt-common/src/main/java/org/ovirt/engine/ui/common/widget/editor/ListModelDaysOfMonthSelector.java M frontend/webadmin/modules/gwt-common/src/main/java/org/ovirt/engine/ui/common/widget/editor/ListModelDaysOfMonthSelectorEditor.java 6 files changed, 97 insertions(+), 13 deletions(-) git pull ssh://gerrit.ovirt.org:29418/ovirt-engine refs/changes/35/38735/1 diff --git a/frontend/webadmin/modules/gwt-common/src/main/java/org/ovirt/engine/ui/common/widget/editor/CheckBoxGroup.java b/frontend/webadmin/modules/gwt-common/src/main/java/org/ovirt/engine/ui/common/widget/editor/CheckBoxGroup.java index 2366442..31ab87d 100644 --- a/frontend/webadmin/modules/gwt-common/src/main/java/org/ovirt/engine/ui/common/widget/editor/CheckBoxGroup.java +++ b/frontend/webadmin/modules/gwt-common/src/main/java/org/ovirt/engine/ui/common/widget/editor/CheckBoxGroup.java @@ -29,9 +29,8 @@ import com.google.gwt.user.client.ui.HasConstrainedValue; /** - * The CheckboxGroup Widget is used to group together a set of Checkbox buttons. By default first checkbox is checked - * due to default behaviour of UiCommonEditorVisitor. Use clearAllSelections to deselect all checkboxes. Any number of - * checkboxes can be checked/set at any point in time. Pushing/Clicking any checkbox in the group toggles its state. + * The CheckboxGroup Widget is used to group together a set of Checkbox buttons. Any number of checkboxes can be + * checked/set at any point in time. Pushing/Clicking any checkbox in the group toggles its state. */ public class CheckBoxGroup<T> extends Composite implements TakesValue<List<T>>, HasConstrainedValue<List<T>> { @@ -41,9 +40,9 @@ private static Resources RESOURCES = GWT.create(Resources.class); private final FlowPanel wrapperPanel = new FlowPanel(); - private CheckBoxGroupCss style; + private final CheckBoxGroupCss style; - private boolean enabled = true; + private final boolean enabled = true; Renderer<T> renderer; @@ -54,6 +53,11 @@ CheckBoxGroupCss checkBoxGroupCss(); } + /** + * CheckBoxGroup construcor. + * @param renderer + * to render the values passed to ListModel's setItems and hence setAcceptableValues + */ public CheckBoxGroup(Renderer<T> renderer) { this.renderer = renderer; style = RESOURCES.checkBoxGroupCss(); @@ -77,6 +81,7 @@ newCheckBox.addClickHandler(new ClickHandler() { @Override public void onClick(ClickEvent event) { + // ValueChangeEvent fired to notify the mapped ListModel about the new Selection/deselection. ValueChangeEvent.fire(CheckBoxGroup.this, getValue()); } }); @@ -111,6 +116,9 @@ /** * Enable/disable all checkboxes + * @param enabled + * boolean whether to enable/disable all checkboxes + * @return void */ public void setEnabled(boolean enabled) { for(Entry<T, CheckBox> currentValue : checkBoxes.entrySet()) { @@ -126,6 +134,15 @@ tabIndex = index; } + /** + * When the mapped ListModel does a setSelectedItem, this is invoked. This method sets checked, the checkboxes + * corresponding to the list passed to it. + * @param value + * list of checkboxes to set checked. + * @param fireEvents + * whether to fire ValueChangeEvent + * @return void + */ @Override public void setValue(List<T> value, boolean fireEvents) { for (T currentvalue : value) { @@ -143,6 +160,12 @@ return addHandler(handler, ValueChangeEvent.getType()); } + /** + * Api to add list of CheckBoxes to the CheckBoxGroup. This is invoked by the mapped ListModel's setItems. + * @param values + * list of values for which checkboxes are to be created in the group. + * @return void + */ @Override public void setAcceptableValues(Collection<List<T>> values) { if (values.isEmpty()) { @@ -163,11 +186,22 @@ } } + /** + * When the mapped ListModel does a setSelectedItem, this is invoked. This method sets checked, the checkboxes + * corresponding to the list passed to it. + * @param value + * list of checkboxes to set checked. + * @return void + */ @Override public void setValue(List<T> value) { setValue(value, false); } + /** + * Calculate and obtain the list of checkboxes checked + * @return List of checkboxes checked + */ @Override public List<T> getValue() { List<T> selectedItems = new ArrayList<>(); diff --git a/frontend/webadmin/modules/gwt-common/src/main/java/org/ovirt/engine/ui/common/widget/editor/DaysOfMonthSelector.java b/frontend/webadmin/modules/gwt-common/src/main/java/org/ovirt/engine/ui/common/widget/editor/DaysOfMonthSelector.java index 128a2a7..5655b77 100644 --- a/frontend/webadmin/modules/gwt-common/src/main/java/org/ovirt/engine/ui/common/widget/editor/DaysOfMonthSelector.java +++ b/frontend/webadmin/modules/gwt-common/src/main/java/org/ovirt/engine/ui/common/widget/editor/DaysOfMonthSelector.java @@ -22,6 +22,10 @@ import com.google.gwt.user.client.ui.HasValue; import com.google.gwt.user.client.ui.Label; +/** + * This widget can be used to capture dates for monthly recurrent events. Currently it has been built to facilitate + * Quartz scheduling. + */ public class DaysOfMonthSelector extends Composite implements TakesValue<String>, HasValue<String> { private static final int DAYS_IN_WEEK = 7; @@ -29,7 +33,7 @@ private static final UIConstants constants = ConstantsManager.getInstance().getConstants(); private static Resources RESOURCES = GWT.create(Resources.class); - private DaysOfMonthSelectorCss style; + private final DaysOfMonthSelectorCss style; private final FlowPanel wrapperPanel = new FlowPanel(); private final FlexTable daysOfMonth = new FlexTable(); @@ -42,6 +46,9 @@ DaysOfMonthSelectorCss daysOfMonthSelectorCSS(); } + /** + * DaysOfMonthSelector + */ public DaysOfMonthSelector() { initWidget(wrapperPanel); style = RESOURCES.daysOfMonthSelectorCSS(); @@ -96,6 +103,14 @@ wrapperPanel.add(daysOfMonth); } + /** + * When the mapped ListModel does a setSelectedItem, this is invoked. This method sets the passed dates selected + * @param value + * Comma separated string of dates to mark selected + * @param fireEvents + * whether to fire ValueChangeEvent + * @return void + */ @Override public void setValue(String value, boolean fireEvents) { clearSelections(); @@ -113,6 +128,12 @@ } } + /** + * When the mapped ListModel does a setSelectedItem, this is invoked. This method sets the passed dates selected + * @param value + * Comma separated string of dates to mark selected + * @return void + */ @Override public void setValue(String value) { setValue(value, false); @@ -125,6 +146,10 @@ } } + /** + * This method calculates and returns the comma-separated string of dates selected in the widget. + * @return String Comma-separated string of dates selected in the widget. + */ @Override public String getValue() { String selectedValues = null; diff --git a/frontend/webadmin/modules/gwt-common/src/main/java/org/ovirt/engine/ui/common/widget/editor/ListModelCheckBoxGroup.java b/frontend/webadmin/modules/gwt-common/src/main/java/org/ovirt/engine/ui/common/widget/editor/ListModelCheckBoxGroup.java index d1757bc..9438f4c 100644 --- a/frontend/webadmin/modules/gwt-common/src/main/java/org/ovirt/engine/ui/common/widget/editor/ListModelCheckBoxGroup.java +++ b/frontend/webadmin/modules/gwt-common/src/main/java/org/ovirt/engine/ui/common/widget/editor/ListModelCheckBoxGroup.java @@ -7,7 +7,7 @@ import com.google.gwt.user.client.ui.HasConstrainedValue; /** - * ListModel bound CheckBoxGroup that uses {@link CheckBoxGroup}. + * ListModel bound CheckBoxGroup that extends {@link CheckBoxGroup}. */ public class ListModelCheckBoxGroup<T> extends CheckBoxGroup<T> implements EditorWidget<List<T>, TakesValueEditor<List<T>>>, HasConstrainedValue<List<T>> { @@ -15,6 +15,11 @@ private char accessKey; + /** + * Constructor of ListModel bound CheckBoxGroup + * @param renderer + * to render the values passed to ListModel's setItems and hence setAcceptableValues + */ public ListModelCheckBoxGroup(Renderer<T> renderer) { super(renderer); } diff --git a/frontend/webadmin/modules/gwt-common/src/main/java/org/ovirt/engine/ui/common/widget/editor/ListModelCheckBoxGroupEditor.java b/frontend/webadmin/modules/gwt-common/src/main/java/org/ovirt/engine/ui/common/widget/editor/ListModelCheckBoxGroupEditor.java index 68b1908..d2e52c8 100644 --- a/frontend/webadmin/modules/gwt-common/src/main/java/org/ovirt/engine/ui/common/widget/editor/ListModelCheckBoxGroupEditor.java +++ b/frontend/webadmin/modules/gwt-common/src/main/java/org/ovirt/engine/ui/common/widget/editor/ListModelCheckBoxGroupEditor.java @@ -11,17 +11,26 @@ import com.google.gwt.text.shared.Renderer; /** - * ListModel bound CheckBoxGroup Editor that uses {@link ListModelCheckBoxGroup}. + * ListModel bound CheckBoxGroup Editor with Label that uses {@link ListModelCheckBoxGroup}. */ public class ListModelCheckBoxGroupEditor<T> extends AbstractValidatedWidgetWithLabel<List<T>, ListModelCheckBoxGroup<T>> implements IsEditor<WidgetWithLabelEditor<List<T>, ListModelCheckBoxGroupEditor<T>>>{ private final WidgetWithLabelEditor<List<T>, ListModelCheckBoxGroupEditor<T>> editor; + /** + * Constructor of ListModel bound CheckBoxGroup Editor with Label that uses {@link ListModelCheckBoxGroup} It uses + * the default String renderer to render the values as CheckBox labels in the CheckBoxGroup. + */ public ListModelCheckBoxGroupEditor() { this(new StringRenderer<T>()); } + /** + * Constructor of ListModel bound CheckBoxGroup Editor with Label that uses {@link ListModelCheckBoxGroup} + * @param renderer + * to render the values passed to ListModel's setItems and hence setAcceptableValues + */ public ListModelCheckBoxGroupEditor(Renderer<T> renderer) { super(new ListModelCheckBoxGroup<>(renderer), new VisibilityRenderer.SimpleVisibilityRenderer()); editor = WidgetWithLabelEditor.of(getContentWidget().asEditor(), this); @@ -43,6 +52,10 @@ return editor; } + /** + * Api the provides handle to CheckBoxGroup and hence its public methods. + * @return CheckBoxGroup from the ListModelCheckBoxGroupEditor + */ public CheckBoxGroup<T> asCheckBoxGroup() { return getContentWidget(); } diff --git a/frontend/webadmin/modules/gwt-common/src/main/java/org/ovirt/engine/ui/common/widget/editor/ListModelDaysOfMonthSelector.java b/frontend/webadmin/modules/gwt-common/src/main/java/org/ovirt/engine/ui/common/widget/editor/ListModelDaysOfMonthSelector.java index f264e46..89b8b07 100644 --- a/frontend/webadmin/modules/gwt-common/src/main/java/org/ovirt/engine/ui/common/widget/editor/ListModelDaysOfMonthSelector.java +++ b/frontend/webadmin/modules/gwt-common/src/main/java/org/ovirt/engine/ui/common/widget/editor/ListModelDaysOfMonthSelector.java @@ -13,7 +13,7 @@ import com.google.gwt.user.client.ui.HasConstrainedValue; /** - * ListModel bound DaysOfMonthSelector that uses {@link DaysOfMonthSelector}. + * ListModel bound DaysOfMonthSelector that extends {@link DaysOfMonthSelector}. */ public class ListModelDaysOfMonthSelector extends DaysOfMonthSelector implements EditorWidget<String, TakesValueEditor<String>>, HasConstrainedValue<String> { diff --git a/frontend/webadmin/modules/gwt-common/src/main/java/org/ovirt/engine/ui/common/widget/editor/ListModelDaysOfMonthSelectorEditor.java b/frontend/webadmin/modules/gwt-common/src/main/java/org/ovirt/engine/ui/common/widget/editor/ListModelDaysOfMonthSelectorEditor.java index eb9a919..2a42c42 100644 --- a/frontend/webadmin/modules/gwt-common/src/main/java/org/ovirt/engine/ui/common/widget/editor/ListModelDaysOfMonthSelectorEditor.java +++ b/frontend/webadmin/modules/gwt-common/src/main/java/org/ovirt/engine/ui/common/widget/editor/ListModelDaysOfMonthSelectorEditor.java @@ -8,19 +8,26 @@ import com.google.gwt.dom.client.Style.BorderStyle; import com.google.gwt.editor.client.IsEditor; -public class ListModelDaysOfMonthSelectorEditor extends AbstractValidatedWidgetWithLabel<String, ListModelDaysOfMonthSelector> implements IsEditor<WidgetWithLabelEditor<String, ListModelDaysOfMonthSelectorEditor>> { +/** + * ListModel bound DaysOfMonthSelector editor with Label that uses {@link ListModelDaysOfMonthSelector}. + */ - /** - * ListModel bound DaysOfMonthSelector editor that uses {@link ListModelDaysOfMonthSelector}. - */ +public class ListModelDaysOfMonthSelectorEditor extends AbstractValidatedWidgetWithLabel<String, ListModelDaysOfMonthSelector> implements IsEditor<WidgetWithLabelEditor<String, ListModelDaysOfMonthSelectorEditor>> { private final WidgetWithLabelEditor<String, ListModelDaysOfMonthSelectorEditor> editor; + /** + * ListModel bound DaysOfMonthSelector editor with Label Constructor + */ public ListModelDaysOfMonthSelectorEditor() { super(new ListModelDaysOfMonthSelector(), new VisibilityRenderer.SimpleVisibilityRenderer()); editor = WidgetWithLabelEditor.of(getContentWidget().asEditor(), this); } + /** + * Api the provides handle to DaysOfMonthSelector and hence its public methods. + * @return DaysOfMonthSelector + */ public DaysOfMonthSelector asDaysOfMonthSelector() { return getContentWidget(); } -- To view, visit https://gerrit.ovirt.org/38735 To unsubscribe, visit https://gerrit.ovirt.org/settings Gerrit-MessageType: newchange Gerrit-Change-Id: I46d9189dcb1fb2f7d80321488a06d2dd67386e78 Gerrit-PatchSet: 1 Gerrit-Project: ovirt-engine Gerrit-Branch: master Gerrit-Owner: anmolbabu <anb...@redhat.com> _______________________________________________ Engine-patches mailing list Engine-patches@ovirt.org http://lists.ovirt.org/mailman/listinfo/engine-patches
