From 04ce8311762c5f3144a9e566df279bd0e2e774a8 Mon Sep 17 00:00:00 2001 From: Artur Signell Date: Tue, 2 Sep 2008 12:53:12 +0000 Subject: Mass format svn changeset:5331/svn branch:trunk --- src/com/itmill/toolkit/ui/AbstractLayout.java | 6 +- src/com/itmill/toolkit/ui/AbstractSelect.java | 126 +++++++-------- src/com/itmill/toolkit/ui/Accordion.java | 2 +- src/com/itmill/toolkit/ui/BaseFieldFactory.java | 4 +- src/com/itmill/toolkit/ui/CheckBox.java | 20 +-- src/com/itmill/toolkit/ui/Component.java | 92 +++++------ src/com/itmill/toolkit/ui/ComponentContainer.java | 38 ++--- src/com/itmill/toolkit/ui/CustomComponent.java | 6 +- src/com/itmill/toolkit/ui/DateField.java | 28 ++-- src/com/itmill/toolkit/ui/Embedded.java | 24 +-- src/com/itmill/toolkit/ui/ExpandLayout.java | 2 +- src/com/itmill/toolkit/ui/Field.java | 6 +- src/com/itmill/toolkit/ui/FieldFactory.java | 22 +-- src/com/itmill/toolkit/ui/Layout.java | 10 +- src/com/itmill/toolkit/ui/Link.java | 28 ++-- src/com/itmill/toolkit/ui/ListSelect.java | 4 +- src/com/itmill/toolkit/ui/NativeSelect.java | 2 +- src/com/itmill/toolkit/ui/OrderedLayout.java | 33 ++-- src/com/itmill/toolkit/ui/Panel.java | 18 +-- src/com/itmill/toolkit/ui/ProgressIndicator.java | 14 +- src/com/itmill/toolkit/ui/Select.java | 14 +- src/com/itmill/toolkit/ui/SplitPanel.java | 23 ++- src/com/itmill/toolkit/ui/Table.java | 180 +++++++++++----------- src/com/itmill/toolkit/ui/Tree.java | 4 +- src/com/itmill/toolkit/ui/TwinColSelect.java | 4 +- 25 files changed, 360 insertions(+), 350 deletions(-) (limited to 'src/com/itmill/toolkit/ui') diff --git a/src/com/itmill/toolkit/ui/AbstractLayout.java b/src/com/itmill/toolkit/ui/AbstractLayout.java index 0842cbea4f..59f7aa1923 100644 --- a/src/com/itmill/toolkit/ui/AbstractLayout.java +++ b/src/com/itmill/toolkit/ui/AbstractLayout.java @@ -43,7 +43,7 @@ public abstract class AbstractLayout extends AbstractComponentContainer * (non-Javadoc) * * @see com.itmill.toolkit.ui.Layout#setMargin(boolean, boolean, boolean, - * boolean) + * boolean) */ public void setMargin(boolean topEnabled, boolean rightEnabled, boolean bottomEnabled, boolean leftEnabled) { @@ -56,7 +56,9 @@ public abstract class AbstractLayout extends AbstractComponentContainer /* * (non-Javadoc) * - * @see com.itmill.toolkit.ui.AbstractComponent#paintContent(com.itmill.toolkit.terminal.PaintTarget) + * @see + * com.itmill.toolkit.ui.AbstractComponent#paintContent(com.itmill.toolkit + * .terminal.PaintTarget) */ public void paintContent(PaintTarget target) throws PaintException { diff --git a/src/com/itmill/toolkit/ui/AbstractSelect.java b/src/com/itmill/toolkit/ui/AbstractSelect.java index c1f192586e..68460748dd 100644 --- a/src/com/itmill/toolkit/ui/AbstractSelect.java +++ b/src/com/itmill/toolkit/ui/AbstractSelect.java @@ -47,8 +47,8 @@ public abstract class AbstractSelect extends AbstractField implements Container.ItemSetChangeListener { /** - * Item caption mode: Item's ID's String representation is - * used as caption. + * Item caption mode: Item's ID's String representation is used + * as caption. */ public static final int ITEM_CAPTION_MODE_ID = 0; /** @@ -87,8 +87,8 @@ public abstract class AbstractSelect extends AbstractField implements * entered value. The value is matched to the item caption. * FILTERINGMODE_OFF (0) turns the filtering off. * FILTERINGMODE_STARTSWITH (1) matches from the start of the - * caption. FILTERINGMODE_CONTAINS (1) matches anywhere in - * the caption. + * caption. FILTERINGMODE_CONTAINS (1) matches anywhere in the + * caption. */ public interface Filtering { public static final int FILTERINGMODE_OFF = 0; @@ -99,7 +99,7 @@ public abstract class AbstractSelect extends AbstractField implements * Sets the option filtering mode. * * @param filteringMode - * the filtering mode to use + * the filtering mode to use */ public void setFilteringMode(int filteringMode); @@ -206,10 +206,9 @@ public abstract class AbstractSelect extends AbstractField implements * Creates a new select that is connected to a data-source. * * @param caption - * the Caption of the component. + * the Caption of the component. * @param dataSource - * the Container datasource to be selected from by this - * select. + * the Container datasource to be selected from by this select. */ public AbstractSelect(String caption, Container dataSource) { setCaption(caption); @@ -220,9 +219,9 @@ public abstract class AbstractSelect extends AbstractField implements * Creates a new select that is filled from a collection of option values. * * @param caption - * the Caption of this field. + * the Caption of this field. * @param options - * the Collection containing the options. + * the Collection containing the options. */ public AbstractSelect(String caption, Collection options) { @@ -244,9 +243,9 @@ public abstract class AbstractSelect extends AbstractField implements * Paints the content of this component. * * @param target - * the Paint Event. + * the Paint Event. * @throws PaintException - * if the paint operation failed. + * if the paint operation failed. */ public void paintContent(PaintTarget target) throws PaintException { @@ -531,9 +530,9 @@ public abstract class AbstractSelect extends AbstractField implements /** * Returns the type of the property. getValue and - * setValue methods must be compatible with this type: one - * can safely cast getValue to given type and pass any - * variable assignable to this type as a parameter to setValue. + * setValue methods must be compatible with this type: one can + * safely cast getValue to given type and pass any variable + * assignable to this type as a parameter to setValue. * * @return the Type of the property. */ @@ -586,7 +585,7 @@ public abstract class AbstractSelect extends AbstractField implements *

* * @param newValue - * the New selected item or collection of selected items. + * the New selected item or collection of selected items. * @see com.itmill.toolkit.ui.AbstractField#setValue(java.lang.Object) */ public void setValue(Object newValue) throws Property.ReadOnlyException, @@ -608,9 +607,9 @@ public abstract class AbstractSelect extends AbstractField implements *

* * @param newValue - * the New selected item or collection of selected items. + * the New selected item or collection of selected items. * @param repaintIsNotNeeded - * True if caller is sure that repaint is not needed. + * True if caller is sure that repaint is not needed. * @see com.itmill.toolkit.ui.AbstractField#setValue(java.lang.Object, * java.lang.Boolean) */ @@ -636,7 +635,7 @@ public abstract class AbstractSelect extends AbstractField implements * contain the requested item, null is returned. * * @param itemId - * the item id. + * the item id. * @return the item from the container. */ public Item getItem(Object itemId) { @@ -665,7 +664,7 @@ public abstract class AbstractSelect extends AbstractField implements * Gets the property type. * * @param propertyId - * the Id identifying the property. + * the Id identifying the property. * @see com.itmill.toolkit.data.Container#getType(java.lang.Object) */ public Class getType(Object propertyId) { @@ -687,7 +686,7 @@ public abstract class AbstractSelect extends AbstractField implements * Tests, if the collection contains an item with given id. * * @param itemId - * the Id the of item to be tested. + * the Id the of item to be tested. */ public boolean containsId(Object itemId) { if (itemId != null) { @@ -780,7 +779,7 @@ public abstract class AbstractSelect extends AbstractField implements * returns null. * * @param itemId - * the Identification of the item to be created. + * the Identification of the item to be created. * @return the Created item with the given id, or null in case of failure. * @see com.itmill.toolkit.data.Container#addItem(java.lang.Object) */ @@ -840,7 +839,7 @@ public abstract class AbstractSelect extends AbstractField implements * Sets the container as data-source for viewing. * * @param newDataSource - * the new data source. + * the new data source. */ public void setContainerDataSource(Container newDataSource) { if (newDataSource == null) { @@ -911,7 +910,7 @@ public abstract class AbstractSelect extends AbstractField implements * selected items, only one of the selected items is kept as selected. * * @param multiSelect - * the New value of property multiSelect. + * the New value of property multiSelect. */ public void setMultiSelect(boolean multiSelect) { if (multiSelect && getNullSelectionItemId() != null) { @@ -963,7 +962,7 @@ public abstract class AbstractSelect extends AbstractField implements * Enables or disables possibility to add new options by the user. * * @param allowNewOptions - * the New value of property allowNewOptions. + * the New value of property allowNewOptions. */ public void setNewItemsAllowed(boolean allowNewOptions) { @@ -981,9 +980,9 @@ public abstract class AbstractSelect extends AbstractField implements * item and index captions. * * @param itemId - * the id of the item to be recaptioned. + * the id of the item to be recaptioned. * @param caption - * the New caption. + * the New caption. */ public void setItemCaption(Object itemId, String caption) { if (itemId != null) { @@ -998,7 +997,7 @@ public abstract class AbstractSelect extends AbstractField implements * details. * * @param itemId - * the id of the item to be queried. + * the id of the item to be queried. * @return the caption for specified item. */ public String getItemCaption(Object itemId) { @@ -1060,9 +1059,9 @@ public abstract class AbstractSelect extends AbstractField implements * Sets the icon for an item. * * @param itemId - * the id of the item to be assigned an icon. + * the id of the item to be assigned an icon. * @param icon - * the New icon. + * the New icon. */ public void setItemIcon(Object itemId, Resource icon) { if (itemId != null) { @@ -1079,7 +1078,7 @@ public abstract class AbstractSelect extends AbstractField implements * Gets the item icon. * * @param itemId - * the id of the item to be assigned an icon. + * the id of the item to be assigned an icon. * @return the Icon for the item or null, if not specified. */ public Resource getItemIcon(Object itemId) { @@ -1118,13 +1117,13 @@ public abstract class AbstractSelect extends AbstractField implements * toString is used as item caption. *
  • ITEM_CAPTION_MODE_ITEM : Item-objects * toString is used as item caption.
    • - *
  • ITEM_CAPTION_MODE_INDEX : The index of the item is - * used as item caption. The index mode can only be used with the containers + *
  • ITEM_CAPTION_MODE_INDEX : The index of the item is used + * as item caption. The index mode can only be used with the containers * implementing Container.Indexed interface.
    • - *
  • ITEM_CAPTION_MODE_EXPLICIT : The item captions must - * be explicitly specified.
    • - *
  • ITEM_CAPTION_MODE_PROPERTY : The item captions are - * read from property, that must be specified with + *
  • ITEM_CAPTION_MODE_EXPLICIT : The item captions must be + * explicitly specified.
    • + *
  • ITEM_CAPTION_MODE_PROPERTY : The item captions are read + * from property, that must be specified with * setItemCaptionPropertyId.
    • * * The ITEM_CAPTION_MODE_EXPLICIT_DEFAULTS_ID is the default @@ -1132,7 +1131,7 @@ public abstract class AbstractSelect extends AbstractField implements *

    * * @param mode - * the One of the modes listed above. + * the One of the modes listed above. */ public void setItemCaptionMode(int mode) { if (ITEM_CAPTION_MODE_ID <= mode && mode <= ITEM_CAPTION_MODE_PROPERTY) { @@ -1154,13 +1153,13 @@ public abstract class AbstractSelect extends AbstractField implements * toString is used as item caption. *
  • ITEM_CAPTION_MODE_ITEM : Item-objects * toString is used as item caption.
    • - *
  • ITEM_CAPTION_MODE_INDEX : The index of the item is - * used as item caption. The index mode can only be used with the containers + *
  • ITEM_CAPTION_MODE_INDEX : The index of the item is used + * as item caption. The index mode can only be used with the containers * implementing Container.Indexed interface.
    • - *
  • ITEM_CAPTION_MODE_EXPLICIT : The item captions must - * be explicitly specified.
    • - *
  • ITEM_CAPTION_MODE_PROPERTY : The item captions are - * read from property, that must be specified with + *
  • ITEM_CAPTION_MODE_EXPLICIT : The item captions must be + * explicitly specified.
    • + *
  • ITEM_CAPTION_MODE_PROPERTY : The item captions are read + * from property, that must be specified with * setItemCaptionPropertyId.
    • * * The ITEM_CAPTION_MODE_EXPLICIT_DEFAULTS_ID is the default @@ -1179,18 +1178,19 @@ public abstract class AbstractSelect extends AbstractField implements *

    * Setting the id to a existing property implicitly sets the item caption * mode to ITEM_CAPTION_MODE_PROPERTY. If the object is in - * ITEM_CAPTION_MODE_PROPERTY mode, setting caption property - * id null resets the item caption mode to + * ITEM_CAPTION_MODE_PROPERTY mode, setting caption property id + * null resets the item caption mode to * ITEM_CAPTION_EXPLICIT_DEFAULTS_ID. *

    * *

    * Setting the property id to null disables this feature. The id is null by * default - *

    . + *

    + * . * * @param propertyId - * the id of the property. + * the id of the property. * */ public void setItemCaptionPropertyId(Object propertyId) { @@ -1226,17 +1226,18 @@ public abstract class AbstractSelect extends AbstractField implements *

    * *

    - * Note : The icons set with setItemIcon function override - * the icons from the property. + * Note : The icons set with setItemIcon function override the + * icons from the property. *

    * *

    * Setting the property id to null disables this feature. The id is null by * default - *

    . + *

    + * . * * @param propertyId - * the Id of the property that specifies icons for items. + * the Id of the property that specifies icons for items. */ public void setItemIconPropertyId(Object propertyId) { if ((propertyId != null) @@ -1258,14 +1259,15 @@ public abstract class AbstractSelect extends AbstractField implements *

    * *

    - * Note : The icons set with setItemIcon function override - * the icons from the property. + * Note : The icons set with setItemIcon function override the + * icons from the property. *

    * *

    * Setting the property id to null disables this feature. The id is null by * default - *

    . + *

    + * . * * @return the Id of the property containing the item icons. */ @@ -1283,7 +1285,7 @@ public abstract class AbstractSelect extends AbstractField implements *

    * * @param itemId - * the Id the of the item to be tested. + * the Id the of the item to be tested. * @see #getNullSelectionItemId() * @see #setNullSelectionItemId(Object) * @@ -1310,7 +1312,7 @@ public abstract class AbstractSelect extends AbstractField implements *

    * * @param itemId - * the tem to be selected. + * the tem to be selected. * @see #getNullSelectionItemId() * @see #setNullSelectionItemId(Object) * @@ -1330,7 +1332,7 @@ public abstract class AbstractSelect extends AbstractField implements * Unselects an item. * * @param itemId - * the Item to be unselected. + * the Item to be unselected. * @see #getNullSelectionItemId() * @see #setNullSelectionItemId(Object) * @@ -1489,11 +1491,11 @@ public abstract class AbstractSelect extends AbstractField implements /** * Allow of disallow empty selection. If the select is in single-select * mode, you can make an item represent the empty selection by calling - * setNullSelectionItemId(). This way you can for instance - * set an icon and caption for the null selection item. + * setNullSelectionItemId(). This way you can for instance set + * an icon and caption for the null selection item. * * @param nullSelectionAllowed - * whether or not to allow empty selection + * whether or not to allow empty selection * @see #setNullSelectionItemId(Object) * @see #isNullSelectionAllowed() */ @@ -1540,7 +1542,7 @@ public abstract class AbstractSelect extends AbstractField implements *

    * * @param nullSelectionItemId - * the nullSelectionItemId to set. + * the nullSelectionItemId to set. * @see #getNullSelectionItemId() * @see #isSelected(Object) * @see #select(Object) diff --git a/src/com/itmill/toolkit/ui/Accordion.java b/src/com/itmill/toolkit/ui/Accordion.java index 4973303bfd..e057bbc6a1 100644 --- a/src/com/itmill/toolkit/ui/Accordion.java +++ b/src/com/itmill/toolkit/ui/Accordion.java @@ -1,7 +1,7 @@ package com.itmill.toolkit.ui; public class Accordion extends TabSheet { - + public String getTag() { return "accordion"; } diff --git a/src/com/itmill/toolkit/ui/BaseFieldFactory.java b/src/com/itmill/toolkit/ui/BaseFieldFactory.java index 6ab3ccf114..3e9e3666f2 100644 --- a/src/com/itmill/toolkit/ui/BaseFieldFactory.java +++ b/src/com/itmill/toolkit/ui/BaseFieldFactory.java @@ -31,9 +31,9 @@ public class BaseFieldFactory implements FieldFactory { * * * @param type - * the type of data presented in field. + * the type of data presented in field. * @param uiContext - * the context where the Field is presented. + * the context where the Field is presented. * * @see com.itmill.toolkit.ui.FieldFactory#createField(Class, Component) */ diff --git a/src/com/itmill/toolkit/ui/CheckBox.java b/src/com/itmill/toolkit/ui/CheckBox.java index 86ba0fee95..58855c9a62 100644 --- a/src/com/itmill/toolkit/ui/CheckBox.java +++ b/src/com/itmill/toolkit/ui/CheckBox.java @@ -20,9 +20,9 @@ public class CheckBox extends Button { * Creates a new switch button with a caption and a set initial state. * * @param caption - * the caption of the switch button + * the caption of the switch button * @param initialState - * the initial state of the switch button + * the initial state of the switch button */ public CheckBox(String caption, boolean initialState) { setCaption(caption); @@ -34,9 +34,9 @@ public class CheckBox extends Button { * Creates a new switch button with a caption and a click listener. * * @param caption - * the caption of the switch button + * the caption of the switch button * @param listener - * the click listener + * the click listener */ public CheckBox(String caption, ClickListener listener) { setCaption(caption); @@ -54,12 +54,12 @@ public class CheckBox extends Button { * Button.ClickEvent type. * * @param caption - * the Button caption. + * the Button caption. * @param target - * the Object having the method for listening button clicks. + * the Object having the method for listening button clicks. * @param methodName - * the name of the method in target object, that receives - * button click events. + * the name of the method in target object, that receives button + * click events. */ public CheckBox(String caption, Object target, String methodName) { setCaption(caption); @@ -71,7 +71,7 @@ public class CheckBox extends Button { * Creates a new switch button that is connected to a boolean property. * * @param state - * the Initial state of the switch-button. + * the Initial state of the switch-button. * @param dataSource */ public CheckBox(String caption, Property dataSource) { @@ -87,7 +87,7 @@ public class CheckBox extends Button { * default. * * @param caption - * the Button caption. + * the Button caption. */ public CheckBox(String caption) { diff --git a/src/com/itmill/toolkit/ui/Component.java b/src/com/itmill/toolkit/ui/Component.java index 3f7d1ed764..b4a8c02f0f 100644 --- a/src/com/itmill/toolkit/ui/Component.java +++ b/src/com/itmill/toolkit/ui/Component.java @@ -37,10 +37,11 @@ public interface Component extends Paintable, VariableOwner, Sizeable { /** * Sets and replaces all previous style names of the component. This method * will trigger a - * {@link com.itmill.toolkit.terminal.Paintable.RepaintRequestEvent RepaintRequestEvent}. + * {@link com.itmill.toolkit.terminal.Paintable.RepaintRequestEvent + * RepaintRequestEvent}. * * @param style - * the new style of the component. + * the new style of the component. */ public void setStyleName(String style); @@ -50,10 +51,11 @@ public interface Component extends Paintable, VariableOwner, Sizeable { * classes as given on server side. * * This method will trigger a - * {@link com.itmill.toolkit.terminal.Paintable.RepaintRequestEvent RepaintRequestEvent}. + * {@link com.itmill.toolkit.terminal.Paintable.RepaintRequestEvent + * RepaintRequestEvent}. * * @param style - * the new style to be added to the component + * the new style to be added to the component */ public void addStyleName(String style); @@ -61,7 +63,7 @@ public interface Component extends Paintable, VariableOwner, Sizeable { * Removes given style name from component. * * @param style - * the style to be removed + * the style to be removed */ public void removeStyleName(String style); @@ -77,8 +79,8 @@ public interface Component extends Paintable, VariableOwner, Sizeable { * Components should be enabled by default. *

    * - * @return true if the component is enabled, - * false if not. + * @return true if the component is enabled, false + * if not. * @see VariableOwner#isEnabled() */ public boolean isEnabled(); @@ -86,11 +88,12 @@ public interface Component extends Paintable, VariableOwner, Sizeable { /** * Enables or disables the component. Being enabled means that the component * can be edited. This method will trigger a - * {@link com.itmill.toolkit.terminal.Paintable.RepaintRequestEvent RepaintRequestEvent}. + * {@link com.itmill.toolkit.terminal.Paintable.RepaintRequestEvent + * RepaintRequestEvent}. * * @param enabled - * the boolean value specifying if the component should be - * enabled after the call or not + * the boolean value specifying if the component should be + * enabled after the call or not */ public void setEnabled(boolean enabled); @@ -108,8 +111,8 @@ public interface Component extends Paintable, VariableOwner, Sizeable { * component is shown in the UI or not. * * @param visible - * the Boolean value specifying if the component should be - * visible after the call or not. + * the Boolean value specifying if the component should be + * visible after the call or not. */ public void setVisible(boolean visible); @@ -127,8 +130,8 @@ public interface Component extends Paintable, VariableOwner, Sizeable { *

    * This method calls automatically {@link #attach()} if the parent is * attached to a window (or is itself a window}, and {@link #detach()} if - * parent is set null, but the component was - * in the application. + * parent is set null, but the component was in + * the application. *

    * *

    @@ -137,7 +140,7 @@ public interface Component extends Paintable, VariableOwner, Sizeable { * components to container, which call this method implicitly. * * @param parent - * the new parent component. + * the new parent component. */ public void setParent(Component parent); @@ -152,11 +155,12 @@ public interface Component extends Paintable, VariableOwner, Sizeable { /** * Sets the component's to read-only mode to the specified state. This * method will trigger a - * {@link com.itmill.toolkit.terminal.Paintable.RepaintRequestEvent RepaintRequestEvent}. + * {@link com.itmill.toolkit.terminal.Paintable.RepaintRequestEvent + * RepaintRequestEvent}. * * @param readOnly - * the boolean value specifying if the component should be in - * read-only mode after the call or not. + * the boolean value specifying if the component should be in + * read-only mode after the call or not. */ public void setReadOnly(boolean readOnly); @@ -169,12 +173,13 @@ public interface Component extends Paintable, VariableOwner, Sizeable { public String getCaption(); /** - * Sets the component's caption String. Caption is the - * visible name of the component. This method will trigger a - * {@link com.itmill.toolkit.terminal.Paintable.RepaintRequestEvent RepaintRequestEvent}. + * Sets the component's caption String. Caption is the visible + * name of the component. This method will trigger a + * {@link com.itmill.toolkit.terminal.Paintable.RepaintRequestEvent + * RepaintRequestEvent}. * * @param caption - * the new caption String for the component. + * the new caption String for the component. */ public void setCaption(String caption); @@ -188,10 +193,11 @@ public interface Component extends Paintable, VariableOwner, Sizeable { /** * Sets the component's icon. This method will trigger a - * {@link com.itmill.toolkit.terminal.Paintable.RepaintRequestEvent RepaintRequestEvent}. + * {@link com.itmill.toolkit.terminal.Paintable.RepaintRequestEvent + * RepaintRequestEvent}. * * @param icon - * the icon to be shown with the component's caption. + * the icon to be shown with the component's caption. */ public void setIcon(Resource icon); @@ -216,8 +222,8 @@ public interface Component extends Paintable, VariableOwner, Sizeable { * Notifies the component that it is connected to an application. This * method is always called before the component is first time painted and is * suitable to be extended. The getApplication and - * getWindow methods might return null before - * this method is called. + * getWindow methods might return null before this + * method is called. *

    * *

    @@ -265,16 +271,16 @@ public interface Component extends Paintable, VariableOwner, Sizeable { * themselves. * * @param alreadyNotified - * the collection of repaint request listeners that have been - * already notified by the child. This component should not - * renotify the listed listeners again. The container given - * as parameter must be modifiable as the component might - * modify it and pass it forwards. Null parameter is - * interpreted as empty collection. + * the collection of repaint request listeners that have been + * already notified by the child. This component should not + * renotify the listed listeners again. The container given as + * parameter must be modifiable as the component might modify it + * and pass it forwards. Null parameter is interpreted as empty + * collection. */ public void childRequestedRepaint(Collection alreadyNotified); - /* Component event framework *************************************** */ + /* Component event framework */ /** * Superclass of all component originated Events. @@ -290,7 +296,7 @@ public interface Component extends Paintable, VariableOwner, Sizeable { * Constructs a new event with a specified source component. * * @param source - * the source component of the event. + * the source component of the event. */ public Event(Component source) { super(source); @@ -306,7 +312,7 @@ public interface Component extends Paintable, VariableOwner, Sizeable { * Notifies the listener of a component event. * * @param event - * the event that has occured. + * the event that has occured. */ public void componentEvent(Component.Event event); } @@ -315,7 +321,7 @@ public interface Component extends Paintable, VariableOwner, Sizeable { * Registers a new component event listener for this component. * * @param listener - * the new Listener to be registered. + * the new Listener to be registered. */ public void addListener(Component.Listener listener); @@ -324,7 +330,7 @@ public interface Component extends Paintable, VariableOwner, Sizeable { * component. * * @param listener - * the listener to be removed. + * the listener to be removed. */ public void removeListener(Component.Listener listener); @@ -344,9 +350,9 @@ public interface Component extends Paintable, VariableOwner, Sizeable { * Constructs a new event with a specified source component. * * @param message - * the error message. + * the error message. * @param component - * the source component. + * the source component. */ public ErrorEvent(ErrorMessage message, Component component) { super(component); @@ -372,7 +378,7 @@ public interface Component extends Paintable, VariableOwner, Sizeable { * Notifies the listener of a component error. * * @param event - * the event that has occured. + * the event that has occured. */ public void componentError(Component.ErrorEvent event); } @@ -399,9 +405,9 @@ public interface Component extends Paintable, VariableOwner, Sizeable { * specify the natural tab order of fields. * * @param tabIndex - * the tab order of this component. Indexes usually start - * from 1. Negative value means that field is not wanted - * to tabbing sequence. + * the tab order of this component. Indexes usually start + * from 1. Negative value means that field is not wanted to + * tabbing sequence. */ public void setTabIndex(int tabIndex); diff --git a/src/com/itmill/toolkit/ui/ComponentContainer.java b/src/com/itmill/toolkit/ui/ComponentContainer.java index c5b72ca100..a513b462fe 100644 --- a/src/com/itmill/toolkit/ui/ComponentContainer.java +++ b/src/com/itmill/toolkit/ui/ComponentContainer.java @@ -22,7 +22,7 @@ public interface ComponentContainer extends Component { * Adds the component into this container. * * @param c - * the component to be added. + * the component to be added. */ public void addComponent(Component c); @@ -30,7 +30,7 @@ public interface ComponentContainer extends Component { * Removes the component from this container. * * @param c - * the component to be added. + * the component to be added. */ public void removeComponent(Component c); @@ -53,9 +53,9 @@ public interface ComponentContainer extends Component { *

    * * @param oldComponent - * the old component that will be replaced. + * the old component that will be replaced. * @param newComponent - * the new component to be replaced. + * the new component to be replaced. */ public void replaceComponent(Component oldComponent, Component newComponent); @@ -73,8 +73,8 @@ public interface ComponentContainer extends Component { * components are removed from source. * * @param source - * the container which contains the components that are to be - * moved to this container. + * the container which contains the components that are to be + * moved to this container. */ public void moveComponentsFrom(ComponentContainer source); @@ -82,7 +82,7 @@ public interface ComponentContainer extends Component { * Listens the component attach events. * * @param listener - * the listener to add. + * the listener to add. */ public void addListener(ComponentAttachListener listener); @@ -90,7 +90,7 @@ public interface ComponentContainer extends Component { * Stops the listening component attach events. * * @param listener - * the listener to removed. + * the listener to removed. */ public void removeListener(ComponentAttachListener listener); @@ -113,7 +113,7 @@ public interface ComponentContainer extends Component { * A new component is attached to container. * * @param event - * the component attach event. + * the component attach event. */ public void componentAttachedToContainer(ComponentAttachEvent event); } @@ -127,7 +127,7 @@ public interface ComponentContainer extends Component { * A component has been detached from container. * * @param event - * the component detach event. + * the component detach event. */ public void componentDetachedFromContainer(ComponentDetachEvent event); } @@ -148,10 +148,10 @@ public interface ComponentContainer extends Component { * Creates a new attach event. * * @param container - * the component container the component has been - * detached to. + * the component container the component has been detached + * to. * @param attachedComponent - * the component that has been attached. + * the component that has been attached. */ public ComponentAttachEvent(ComponentContainer container, Component attachedComponent) { @@ -163,7 +163,7 @@ public interface ComponentContainer extends Component { * Gets the component container. * * @param the - * component container. + * component container. */ public ComponentContainer getContainer() { return (ComponentContainer) getSource(); @@ -173,7 +173,7 @@ public interface ComponentContainer extends Component { * Gets the attached component. * * @param the - * attach component. + * attach component. */ public Component getAttachedComponent() { return component; @@ -196,10 +196,10 @@ public interface ComponentContainer extends Component { * Creates a new detach event. * * @param container - * the component container the component has been - * detached from. + * the component container the component has been detached + * from. * @param detachedComponent - * the component that has been detached. + * the component that has been detached. */ public ComponentDetachEvent(ComponentContainer container, Component detachedComponent) { @@ -211,7 +211,7 @@ public interface ComponentContainer extends Component { * Gets the component container. * * @param the - * component container. + * component container. */ public ComponentContainer getContainer() { return (ComponentContainer) getSource(); diff --git a/src/com/itmill/toolkit/ui/CustomComponent.java b/src/com/itmill/toolkit/ui/CustomComponent.java index 5bf6f5d93e..5d141eca8f 100644 --- a/src/com/itmill/toolkit/ui/CustomComponent.java +++ b/src/com/itmill/toolkit/ui/CustomComponent.java @@ -57,7 +57,7 @@ public class CustomComponent extends AbstractComponentContainer { *

    * * @param compositionRoot - * the root of the composition component tree. + * the root of the composition component tree. */ public CustomComponent(Component compositionRoot) { setCompositionRoot(compositionRoot); @@ -80,7 +80,7 @@ public class CustomComponent extends AbstractComponentContainer { *

    * * @param compositionRoot - * the root of the composition component tree. + * the root of the composition component tree. */ protected final void setCompositionRoot(Component compositionRoot) { if (compositionRoot != root) { @@ -131,7 +131,7 @@ public class CustomComponent extends AbstractComponentContainer { * the UIDL as component tag attribute. * * @param componentType - * the componentType to set. + * the componentType to set. */ public void setComponentType(String componentType) { this.componentType = componentType; diff --git a/src/com/itmill/toolkit/ui/DateField.java b/src/com/itmill/toolkit/ui/DateField.java index bd205557fd..a1859af1b5 100644 --- a/src/com/itmill/toolkit/ui/DateField.java +++ b/src/com/itmill/toolkit/ui/DateField.java @@ -21,8 +21,8 @@ import com.itmill.toolkit.terminal.PaintTarget; * compatible with java.util.Date. *

    *

    - * Since DateField extends AbstractField it - * implements the {@link com.itmill.toolkit.data.Buffered}interface. A + * Since DateField extends AbstractField it implements + * the {@link com.itmill.toolkit.data.Buffered}interface. A * DateField is in write-through mode by default, so * {@link com.itmill.toolkit.ui.AbstractField#setWriteThrough(boolean)}must be * called to enable buffering. @@ -35,7 +35,7 @@ import com.itmill.toolkit.terminal.PaintTarget; */ public class DateField extends AbstractField { - /* Private members ************************************************* */ + /* Private members */ /** * Resolution identifier: milliseconds. @@ -102,7 +102,7 @@ public class DateField extends AbstractField { */ private Calendar calendar; - /* Constructors **************************************************** */ + /* Constructors */ /** * Constructs an empty DateField with no caption. @@ -114,7 +114,7 @@ public class DateField extends AbstractField { * Constructs an empty DateField with caption. * * @param caption - * the caption of the datefield. + * the caption of the datefield. */ public DateField(String caption) { setCaption(caption); @@ -125,9 +125,9 @@ public class DateField extends AbstractField { * Property and has the given caption String. * * @param caption - * the caption String for the editor. + * the caption String for the editor. * @param dataSource - * the Property to be edited with this editor. + * the Property to be edited with this editor. */ public DateField(String caption, Property dataSource) { this(dataSource); @@ -139,7 +139,7 @@ public class DateField extends AbstractField { * Property and has no caption. * * @param dataSource - * the Property to be edited with this editor. + * the Property to be edited with this editor. */ public DateField(Property dataSource) throws IllegalArgumentException { if (!Date.class.isAssignableFrom(dataSource.getType())) { @@ -159,16 +159,16 @@ public class DateField extends AbstractField { * is called to bind it. * * @param caption - * the caption String for the editor. + * the caption String for the editor. * @param value - * the Date value. + * the Date value. */ public DateField(String caption, Date value) { setValue(value); setCaption(caption); } - /* Component basic features ********************************************* */ + /* Component basic features */ /* * Paints this component. Don't add a JavaDoc comment here, we use the @@ -238,7 +238,7 @@ public class DateField extends AbstractField { * interface. */ public void changeVariables(Object source, Map variables) { - super.changeVariables(source, variables); + super.changeVariables(source, variables); if (!isReadOnly() && (variables.containsKey("year") @@ -318,7 +318,7 @@ public class DateField extends AbstractField { } } - /* Property features **************************************************** */ + /* Property features */ /* * Gets the edited property's type. Don't add a JavaDoc comment here, we use @@ -397,7 +397,7 @@ public class DateField extends AbstractField { * Sets the resolution of the DateField. * * @param resolution - * the resolution to set. + * the resolution to set. */ public void setResolution(int resolution) { this.resolution = resolution; diff --git a/src/com/itmill/toolkit/ui/Embedded.java b/src/com/itmill/toolkit/ui/Embedded.java index 92736e18da..36a32e1355 100644 --- a/src/com/itmill/toolkit/ui/Embedded.java +++ b/src/com/itmill/toolkit/ui/Embedded.java @@ -91,7 +91,7 @@ public class Embedded extends AbstractComponent { * * @param caption * @param source - * the Source of the embedded object. + * the Source of the embedded object. */ public Embedded(String caption, Resource source) { setCaption(caption); @@ -163,9 +163,9 @@ public class Embedded extends AbstractComponent { * parameter. * * @param name - * the name of the parameter. + * the name of the parameter. * @param value - * the value of the parameter. + * the value of the parameter. */ public void setParameter(String name, String value) { parameters.put(name, value); @@ -187,7 +187,7 @@ public class Embedded extends AbstractComponent { * Removes an object parameter from the list. * * @param name - * the name of the parameter to remove. + * the name of the parameter to remove. */ public void removeParameter(String name) { parameters.remove(name); @@ -245,7 +245,7 @@ public class Embedded extends AbstractComponent { * paths. * * @param codebase - * the codebase to set. + * the codebase to set. */ public void setCodebase(String codebase) { if (codebase != this.codebase @@ -259,7 +259,7 @@ public class Embedded extends AbstractComponent { * Sets the codetype, the MIME-Type of the code. * * @param codetype - * the codetype to set. + * the codetype to set. */ public void setCodetype(String codetype) { if (codetype != this.codetype @@ -273,7 +273,7 @@ public class Embedded extends AbstractComponent { * Sets the mimeType, the MIME-Type of the object. * * @param mimeType - * the mimeType to set. + * the mimeType to set. */ public void setMimeType(String mimeType) { if (mimeType != this.mimeType @@ -287,7 +287,7 @@ public class Embedded extends AbstractComponent { * Sets the standby, the text to display while loading the object. * * @param standby - * the standby to set. + * the standby to set. */ public void setStandby(String standby) { if (standby != this.standby @@ -310,7 +310,7 @@ public class Embedded extends AbstractComponent { * Sets the classId attribute. * * @param classId - * the classId to set. + * the classId to set. */ public void setClassId(String classId) { if (classId != this.classId @@ -350,7 +350,7 @@ public class Embedded extends AbstractComponent { * The type is guessed from resource. * * @param source - * the source to set. + * the source to set. */ public void setSource(Resource source) { if (source != null && !source.equals(this.source)) { @@ -376,7 +376,7 @@ public class Embedded extends AbstractComponent { *

    * * @param type - * the type to set. + * the type to set. */ public void setType(int type) { if (type != TYPE_OBJECT && type != TYPE_IMAGE && type != TYPE_BROWSER) { @@ -401,7 +401,7 @@ public class Embedded extends AbstractComponent { * Sets the archive attribute. * * @param archive - * the archive string to set. + * the archive string to set. */ public void setArchive(String archive) { if (archive != this.archive diff --git a/src/com/itmill/toolkit/ui/ExpandLayout.java b/src/com/itmill/toolkit/ui/ExpandLayout.java index 331519f3bb..a8a284f041 100644 --- a/src/com/itmill/toolkit/ui/ExpandLayout.java +++ b/src/com/itmill/toolkit/ui/ExpandLayout.java @@ -39,7 +39,7 @@ public class ExpandLayout extends OrderedLayout { /** * @param c - * Component which container will be maximized + * Component which container will be maximized */ public void expand(Component c) { expanded = c; diff --git a/src/com/itmill/toolkit/ui/Field.java b/src/com/itmill/toolkit/ui/Field.java index 9532b2cb64..9f63fe0f18 100644 --- a/src/com/itmill/toolkit/ui/Field.java +++ b/src/com/itmill/toolkit/ui/Field.java @@ -47,7 +47,7 @@ public interface Field extends Component, BufferedValidatable, Property, * Sets the field required. Required fields must filled by the user. * * @param required - * Is the field required. + * Is the field required. * @since 3.1 */ public void setRequired(boolean required); @@ -69,7 +69,7 @@ public interface Field extends Component, BufferedValidatable, Property, * @since 5.2.6 */ public String getRequiredError(); - + /** * An Event object specifying the Field whose value has been * changed. @@ -91,7 +91,7 @@ public interface Field extends Component, BufferedValidatable, Property, * Constructs a new event object with the specified source field object. * * @param source - * the field that caused the event. + * the field that caused the event. */ public ValueChangeEvent(Field source) { super(source); diff --git a/src/com/itmill/toolkit/ui/FieldFactory.java b/src/com/itmill/toolkit/ui/FieldFactory.java index 9090f267b5..01bc707cc7 100644 --- a/src/com/itmill/toolkit/ui/FieldFactory.java +++ b/src/com/itmill/toolkit/ui/FieldFactory.java @@ -23,9 +23,9 @@ public interface FieldFactory { * Creates a field based on type of data. * * @param type - * the type of data presented in field. + * the type of data presented in field. * @param uiContext - * the component where the field is presented. + * the component where the field is presented. * @return Field the field suitable for editing the specified data. * */ @@ -35,9 +35,9 @@ public interface FieldFactory { * Creates a field based on the property datasource. * * @param property - * the property datasource. + * the property datasource. * @param uiContext - * the component where the field is presented. + * the component where the field is presented. * @return Field the field suitable for editing the specified data. */ Field createField(Property property, Component uiContext); @@ -46,11 +46,11 @@ public interface FieldFactory { * Creates a field based on the item and property id. * * @param item - * the item where the property belongs to. + * the item where the property belongs to. * @param propertyId - * the Id of the property. + * the Id of the property. * @param uiContext - * the component where the field is presented. + * the component where the field is presented. * @return Field the field suitable for editing the specified data. */ Field createField(Item item, Object propertyId, Component uiContext); @@ -59,13 +59,13 @@ public interface FieldFactory { * Creates a field based on the container item id and property id. * * @param container - * the Container where the property belongs to. + * the Container where the property belongs to. * @param itemId - * the item Id. + * the item Id. * @param propertyId - * the Id of the property. + * the Id of the property. * @param uiContext - * the component where the field is presented. + * the component where the field is presented. * @return Field the field suitable for editing the specified data. */ Field createField(Container container, Object itemId, Object propertyId, diff --git a/src/com/itmill/toolkit/ui/Layout.java b/src/com/itmill/toolkit/ui/Layout.java index d2bc21e85e..e9ed263bb5 100644 --- a/src/com/itmill/toolkit/ui/Layout.java +++ b/src/com/itmill/toolkit/ui/Layout.java @@ -83,13 +83,13 @@ public interface Layout extends ComponentContainer { * is calculated as a bit mask of the two passed values. * * @param childComponent - * the component to align within it's layout cell. + * the component to align within it's layout cell. * @param horizontalAlignment - * the horizontal alignment for the child component - * (left, center, right). Use ALIGNMENT constants. + * the horizontal alignment for the child component (left, + * center, right). Use ALIGNMENT constants. * @param verticalAlignment - * the vertical alignment for the child component (top, - * center, bottom). Use ALIGNMENT constants. + * the vertical alignment for the child component (top, + * center, bottom). Use ALIGNMENT constants. */ public void setComponentAlignment(Component childComponent, int horizontalAlignment, int verticalAlignment); diff --git a/src/com/itmill/toolkit/ui/Link.java b/src/com/itmill/toolkit/ui/Link.java index 3f4b526d9a..d9e90c547f 100644 --- a/src/com/itmill/toolkit/ui/Link.java +++ b/src/com/itmill/toolkit/ui/Link.java @@ -60,17 +60,17 @@ public class Link extends AbstractComponent { * * * @param caption - * the Link text. + * the Link text. * @param targetName - * the name of the target window where the link opens to. - * Empty name of null implies that the target is opened to - * the window containing the link. + * the name of the target window where the link opens to. Empty + * name of null implies that the target is opened to the window + * containing the link. * @param width - * the Width of the target window. + * the Width of the target window. * @param height - * the Height of the target window. + * the Height of the target window. * @param border - * the Border style of the target window. + * the Border style of the target window. * */ public Link(String caption, Resource resource, String targetName, @@ -96,9 +96,9 @@ public class Link extends AbstractComponent { * Paints the content of this component. * * @param target - * the Paint Event. + * the Paint Event. * @throws PaintException - * if the paint operation failed. + * if the paint operation failed. */ public void paintContent(PaintTarget target) throws PaintException { @@ -174,7 +174,7 @@ public class Link extends AbstractComponent { * Sets the border of the target window. * * @param targetBorder - * the targetBorder to set. + * the targetBorder to set. */ public void setTargetBorder(int targetBorder) { if (targetBorder == TARGET_BORDER_DEFAULT @@ -189,7 +189,7 @@ public class Link extends AbstractComponent { * Sets the target window height. * * @param targetHeight - * the targetHeight to set. + * the targetHeight to set. */ public void setTargetHeight(int targetHeight) { this.targetHeight = targetHeight; @@ -200,7 +200,7 @@ public class Link extends AbstractComponent { * Sets the target window name. * * @param targetName - * the targetName to set. + * the targetName to set. */ public void setTargetName(String targetName) { this.targetName = targetName; @@ -211,7 +211,7 @@ public class Link extends AbstractComponent { * Sets the target window width. * * @param targetWidth - * the targetWidth to set. + * the targetWidth to set. */ public void setTargetWidth(int targetWidth) { this.targetWidth = targetWidth; @@ -231,7 +231,7 @@ public class Link extends AbstractComponent { * Sets the resource this link opens. * * @param resource - * the resource to set. + * the resource to set. */ public void setResource(Resource resource) { this.resource = resource; diff --git a/src/com/itmill/toolkit/ui/ListSelect.java b/src/com/itmill/toolkit/ui/ListSelect.java index 303e321e85..96c7a35b0c 100644 --- a/src/com/itmill/toolkit/ui/ListSelect.java +++ b/src/com/itmill/toolkit/ui/ListSelect.java @@ -41,7 +41,7 @@ public class ListSelect extends AbstractSelect { * adapter. * * @param columns - * the number of columns to set. + * the number of columns to set. */ public void setColumns(int columns) { if (columns < 0) { @@ -67,7 +67,7 @@ public class ListSelect extends AbstractSelect { * adapter. * * @param rows - * the number of rows to set. + * the number of rows to set. */ public void setRows(int rows) { if (rows < 0) { diff --git a/src/com/itmill/toolkit/ui/NativeSelect.java b/src/com/itmill/toolkit/ui/NativeSelect.java index d3e445dcf6..c87deb38f4 100644 --- a/src/com/itmill/toolkit/ui/NativeSelect.java +++ b/src/com/itmill/toolkit/ui/NativeSelect.java @@ -43,7 +43,7 @@ public class NativeSelect extends AbstractSelect { * adapter. * * @param columns - * the number of columns to set. + * the number of columns to set. */ public void setColumns(int columns) { if (columns < 0) { diff --git a/src/com/itmill/toolkit/ui/OrderedLayout.java b/src/com/itmill/toolkit/ui/OrderedLayout.java index a3c3da5392..ad85da4c87 100644 --- a/src/com/itmill/toolkit/ui/OrderedLayout.java +++ b/src/com/itmill/toolkit/ui/OrderedLayout.java @@ -26,7 +26,7 @@ import com.itmill.toolkit.terminal.PaintTarget; public class OrderedLayout extends AbstractLayout implements Layout.AlignmentHandler, Layout.SpacingHandler { - /* Predefined orientations ***************************************** */ + /* Predefined orientations */ /** * Components are to be laid out vertically. @@ -45,7 +45,7 @@ public class OrderedLayout extends AbstractLayout implements */ protected LinkedList components = new LinkedList(); - /* Child component alignments ************************************** */ + /* Child component alignments */ /** * Mapping from components to alignments (horizontal + vertical). @@ -75,7 +75,7 @@ public class OrderedLayout extends AbstractLayout implements * parameters. * * @param orientation - * the Orientation of the layout. + * the Orientation of the layout. */ public OrderedLayout(int orientation) { this.orientation = orientation; @@ -95,7 +95,7 @@ public class OrderedLayout extends AbstractLayout implements * or under the previous component. * * @param c - * the component to be added. + * the component to be added. */ public void addComponent(Component c) { super.addComponent(c); @@ -108,7 +108,7 @@ public class OrderedLayout extends AbstractLayout implements * or on top of the other components. * * @param c - * the component to be added. + * the component to be added. */ public void addComponentAsFirst(Component c) { super.addComponent(c); @@ -120,10 +120,10 @@ public class OrderedLayout extends AbstractLayout implements * Adds a component into indexed position in this container. * * @param c - * the component to be added. + * the component to be added. * @param index - * the Index of the component position. The components - * currently in and after the position are shifted forwards. + * the Index of the component position. The components currently + * in and after the position are shifted forwards. */ public void addComponent(Component c, int index) { super.addComponent(c); @@ -135,7 +135,7 @@ public class OrderedLayout extends AbstractLayout implements * Removes the component from this container. * * @param c - * the component to be removed. + * the component to be removed. */ public void removeComponent(Component c) { super.removeComponent(c); @@ -158,9 +158,9 @@ public class OrderedLayout extends AbstractLayout implements * Paints the content of this component. * * @param target - * the Paint Event. + * the Paint Event. * @throws PaintException - * if the paint operation failed. + * if the paint operation failed. */ public void paintContent(PaintTarget target) throws PaintException { super.paintContent(target); @@ -206,7 +206,7 @@ public class OrderedLayout extends AbstractLayout implements * Set the orientation of the container. * * @param orientation - * the New value of property orientation. + * the New value of property orientation. */ public void setOrientation(int orientation) { @@ -268,8 +268,9 @@ public class OrderedLayout extends AbstractLayout implements /* * (non-Javadoc) * - * @see com.itmill.toolkit.ui.Layout.AlignmentHandler#setComponentAlignment(com.itmill.toolkit.ui.Component, - * int, int) + * @see + * com.itmill.toolkit.ui.Layout.AlignmentHandler#setComponentAlignment(com + * .itmill.toolkit.ui.Component, int, int) */ public void setComponentAlignment(Component childComponent, int horizontalAlignment, int verticalAlignment) { @@ -281,7 +282,9 @@ public class OrderedLayout extends AbstractLayout implements /* * (non-Javadoc) * - * @see com.itmill.toolkit.ui.Layout.AlignmentHandler#getComponentAlignment(com.itmill.toolkit.ui.Component) + * @see + * com.itmill.toolkit.ui.Layout.AlignmentHandler#getComponentAlignment(com + * .itmill.toolkit.ui.Component) */ public int getComponentAlignment(Component childComponent) { final Integer bitMask = (Integer) componentToAlignment diff --git a/src/com/itmill/toolkit/ui/Panel.java b/src/com/itmill/toolkit/ui/Panel.java index 6359687c3c..49a8a01dc6 100644 --- a/src/com/itmill/toolkit/ui/Panel.java +++ b/src/com/itmill/toolkit/ui/Panel.java @@ -69,7 +69,7 @@ public class Panel extends AbstractComponentContainer implements Scrollable, * Creates a new empty panel with given layout. Layout must be non-null. * * @param layout - * the layout used in the panel. + * the layout used in the panel. */ public Panel(Layout layout) { setLayout(layout); @@ -79,7 +79,7 @@ public class Panel extends AbstractComponentContainer implements Scrollable, * Creates a new empty panel with caption. Default layout is used. * * @param caption - * the caption used in the panel. + * the caption used in the panel. */ public Panel(String caption) { this(caption, null); @@ -89,9 +89,9 @@ public class Panel extends AbstractComponentContainer implements Scrollable, * Creates a new empty panel with caption. * * @param caption - * the caption of the panel. + * the caption of the panel. * @param layout - * the layout used in the panel. + * the layout used in the panel. */ public Panel(String caption, Layout layout) { this(layout); @@ -116,7 +116,7 @@ public class Panel extends AbstractComponentContainer implements Scrollable, * (changed in 5.2.2). Use function in Layout interface manually. * * @param newLayout - * the New layout of the panel. + * the New layout of the panel. */ public void setLayout(Layout newLayout) { @@ -158,9 +158,9 @@ public class Panel extends AbstractComponentContainer implements Scrollable, * Paints the content of this component. * * @param target - * the Paint Event. + * the Paint Event. * @throws PaintException - * if the paint operation failed. + * if the paint operation failed. */ public void paintContent(PaintTarget target) throws PaintException { layout.paint(target); @@ -233,7 +233,7 @@ public class Panel extends AbstractComponentContainer implements Scrollable, * Adds the component into this container. * * @param c - * the component to be added. + * the component to be added. * @see com.itmill.toolkit.ui.AbstractComponentContainer#addComponent(com.itmill.toolkit.ui.Component) */ public void addComponent(Component c) { @@ -246,7 +246,7 @@ public class Panel extends AbstractComponentContainer implements Scrollable, * Removes the component from this container. * * @param c - * The component to be added. + * The component to be added. * @see com.itmill.toolkit.ui.AbstractComponentContainer#removeComponent(com.itmill.toolkit.ui.Component) */ public void removeComponent(Component c) { diff --git a/src/com/itmill/toolkit/ui/ProgressIndicator.java b/src/com/itmill/toolkit/ui/ProgressIndicator.java index c10ac7daca..4b7104251c 100644 --- a/src/com/itmill/toolkit/ui/ProgressIndicator.java +++ b/src/com/itmill/toolkit/ui/ProgressIndicator.java @@ -83,7 +83,7 @@ public class ProgressIndicator extends AbstractField implements Property, * ProgressIndicator. * * @param readOnly - * True to enable read-only mode, False to disable it. + * True to enable read-only mode, False to disable it. */ public void setReadOnly(boolean readOnly) { if (dataSource == null) { @@ -109,9 +109,9 @@ public class ProgressIndicator extends AbstractField implements Property, * Paints the content of this component. * * @param target - * the Paint Event. + * the Paint Event. * @throws PaintException - * if the Paint Operation fails. + * if the Paint Operation fails. */ public void paintContent(PaintTarget target) throws PaintException { target.addAttribute("indeterminate", indeterminate); @@ -138,7 +138,7 @@ public class ProgressIndicator extends AbstractField implements Property, * is the Float between 0 and 1. * * @param newValue - * the New value of the ProgressIndicator. + * the New value of the ProgressIndicator. * @see com.itmill.toolkit.ui.AbstractField#setValue(java.lang.Object) */ public void setValue(Object newValue) { @@ -182,7 +182,7 @@ public class ProgressIndicator extends AbstractField implements Property, * Sets the property as data-source for viewing. * * @param newDataSource - * the new data source. + * the new data source. * @see com.itmill.toolkit.ui.AbstractField#setPropertyDataSource(com.itmill.toolkit.data.Property) */ public void setPropertyDataSource(Property newDataSource) { @@ -217,7 +217,7 @@ public class ProgressIndicator extends AbstractField implements Property, * Sets wheter or not the ProgressIndicator is indeterminate. * * @param newValue - * true to set to indeterminate mode. + * true to set to indeterminate mode. */ public void setIndeterminate(boolean newValue) { indeterminate = newValue; @@ -237,7 +237,7 @@ public class ProgressIndicator extends AbstractField implements Property, * Sets the interval that component checks for progress. * * @param newValue - * the interval in milliseconds. + * the interval in milliseconds. */ public void setPollingInterval(int newValue) { pollingInterval = newValue; diff --git a/src/com/itmill/toolkit/ui/Select.java b/src/com/itmill/toolkit/ui/Select.java index 738fc96a30..48a1217fdd 100644 --- a/src/com/itmill/toolkit/ui/Select.java +++ b/src/com/itmill/toolkit/ui/Select.java @@ -58,9 +58,9 @@ public class Select extends AbstractSelect implements AbstractSelect.Filtering { */ private boolean optionRequest; - /* Constructors ********************************************************* */ + /* Constructors */ - /* Component methods **************************************************** */ + /* Component methods */ public Select() { super(); @@ -82,9 +82,9 @@ public class Select extends AbstractSelect implements AbstractSelect.Filtering { * Paints the content of this component. * * @param target - * the Paint Event. + * the Paint Event. * @throws PaintException - * if the paint operation failed. + * if the paint operation failed. */ public void paintContent(PaintTarget target) throws PaintException { if (isMultiSelect()) { @@ -232,8 +232,8 @@ public class Select extends AbstractSelect implements AbstractSelect.Filtering { * * @param options * @param needNullSelectOption - * flag to indicate if nullselect option needs to be taken - * into consideration + * flag to indicate if nullselect option needs to be taken into + * consideration */ private List sanitetizeList(List options, boolean needNullSelectOption) { @@ -445,7 +445,7 @@ public class Select extends AbstractSelect implements AbstractSelect.Filtering { * @deprecated * * @param columns - * the number of columns to set. + * the number of columns to set. */ public void setColumns(int columns) { if (columns < 0) { diff --git a/src/com/itmill/toolkit/ui/SplitPanel.java b/src/com/itmill/toolkit/ui/SplitPanel.java index 55286cba8d..6a7cb9e056 100644 --- a/src/com/itmill/toolkit/ui/SplitPanel.java +++ b/src/com/itmill/toolkit/ui/SplitPanel.java @@ -22,7 +22,7 @@ import com.itmill.toolkit.terminal.PaintTarget; */ public class SplitPanel extends AbstractLayout { - /* Predefined orientations ***************************************** */ + /* Predefined orientations */ /** * Components are to be layed out vertically. @@ -63,7 +63,7 @@ public class SplitPanel extends AbstractLayout { * parameters. * * @param orientation - * the Orientation of the layout. + * the Orientation of the layout. */ public SplitPanel(int orientation) { this(); @@ -88,7 +88,7 @@ public class SplitPanel extends AbstractLayout { * or under the previous component. * * @param c - * the component to be added. + * the component to be added. */ public void addComponent(Component c) { if (firstComponent == null) { @@ -125,7 +125,7 @@ public class SplitPanel extends AbstractLayout { * Removes the component from this container. * * @param c - * the component to be removed. + * the component to be removed. */ public void removeComponent(Component c) { super.removeComponent(c); @@ -188,9 +188,9 @@ public class SplitPanel extends AbstractLayout { * Paints the content of this component. * * @param target - * the Paint Event. + * the Paint Event. * @throws PaintException - * if the paint operation failed. + * if the paint operation failed. */ public void paintContent(PaintTarget target) throws PaintException { super.paintContent(target); @@ -228,7 +228,7 @@ public class SplitPanel extends AbstractLayout { * Set the orientation of the container. * * @param orientation - * the New value of property orientation. + * the New value of property orientation. */ public void setOrientation(int orientation) { @@ -256,7 +256,7 @@ public class SplitPanel extends AbstractLayout { * Moves the position of the splitter. * * @param pos - * the new size of the first region in persentage + * the new size of the first region in persentage */ public void setSplitPosition(int pos) { setSplitPosition(pos, UNITS_PERCENTAGE); @@ -266,9 +266,9 @@ public class SplitPanel extends AbstractLayout { * Moves the position of the splitter with given position and unit. * * @param pos - * size of the first region + * size of the first region * @param unit - * the unit (from {@link Size}) in which the size is given. + * the unit (from {@link Size}) in which the size is given. */ public void setSplitPosition(int pos, int unit) { this.pos = pos; @@ -280,8 +280,7 @@ public class SplitPanel extends AbstractLayout { * handle. * * @param locked - * Set true if locked, false - * otherwise. + * Set true if locked, false otherwise. */ public void setLocked(boolean locked) { this.locked = locked; diff --git a/src/com/itmill/toolkit/ui/Table.java b/src/com/itmill/toolkit/ui/Table.java index 8dce0539e1..0d22f641ad 100644 --- a/src/com/itmill/toolkit/ui/Table.java +++ b/src/com/itmill/toolkit/ui/Table.java @@ -370,7 +370,7 @@ public class Table extends AbstractSelect implements Action.Container, *

    * * @param visibleColumns - * the Array of shown property id:s. + * the Array of shown property id:s. */ public void setVisibleColumns(Object[] visibleColumns) { @@ -467,8 +467,8 @@ public class Table extends AbstractSelect implements Action.Container, *

    * * @param columnHeaders - * the Array of column headers that match the - * getVisibleColumns method. + * the Array of column headers that match the + * getVisibleColumns method. */ public void setColumnHeaders(String[] columnHeaders) { @@ -527,8 +527,8 @@ public class Table extends AbstractSelect implements Action.Container, *

    * * @param columnIcons - * the Array of icons that match the - * getVisibleColumns. + * the Array of icons that match the + * getVisibleColumns. */ public void setColumnIcons(Resource[] columnIcons) { @@ -554,8 +554,8 @@ public class Table extends AbstractSelect implements Action.Container, * *

    * The items in the array must match the properties identified by - * getVisibleColumns(). The possible values for the - * alignments include: + * getVisibleColumns(). The possible values for the alignments + * include: *