* RepaintRequestEvent}.
*
* @param style
- * the new style of the component.
+ * the new style of the component.
* @deprecated Use setStyleName() instead; renamed for consistency and to
* indicate that "style" should not be used to switch client
* side implementation, only to style the component.
}
/**
- * Sets the component's caption <code>String</code>. Caption is the
- * visible name of the component. This method will trigger a
+ * Sets the component's caption <code>String</code>. 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 <code>String</code> for the component.
+ * the new caption <code>String</code> for the component.
*/
public void setCaption(String caption) {
this.caption = caption;
* Sets the locale of this component.
*
* @param locale
- * the locale to become this component's locale.
+ * the locale to become this component's locale.
*/
public void setLocale(Locale locale) {
this.locale = locale;
* 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) {
this.icon = icon;
* RepaintRequestEvent}.
*
* @param immediate
- * the boolean value specifying if the component should be in
- * the immediate mode after the call.
+ * the boolean value specifying if the component should be in the
+ * immediate mode after the call.
* @see Component#isImmediate()
*/
public void setImmediate(boolean immediate) {
* RepaintRequestEvent}.
*
* @param description
- * the new description string for the component.
+ * the new description string for the component.
*/
public void setDescription(String description) {
this.description = description;
* @link Component.ErrorMessage#ErrorMessage(String, int)
*
* @param componentError
- * the new <code>ErrorMessage</code> of the component.
+ * the new <code>ErrorMessage</code> of the component.
*/
public void setComponentError(ErrorMessage componentError) {
this.componentError = componentError;
* any component-specific attributes to the UIDL stream.
*
* @param target
- * the target UIDL stream where the component should paint
- * itself to
+ * the target UIDL stream where the component should paint itself
+ * to
* @throws PaintException
- * if the paint operation failed.
+ * if the paint operation failed.
*/
public void paintContent(PaintTarget target) throws PaintException {
* </p>
*
* @param eventType
- * the type of the listened event. Events of this type or its
- * subclasses activate the listener.
+ * the type of the listened event. Events of this type or its
+ * subclasses activate the listener.
* @param object
- * the object instance who owns the activation method.
+ * the object instance who owns the activation method.
* @param method
- * the activation method.
+ * the activation method.
*/
public void addListener(Class eventType, Object object, Method method) {
if (eventRouter == null) {
* </p>
*
* <p>
- * This version of <code>addListener</code> gets the name of the
- * activation method as a parameter. The actual method is reflected from
+ * This version of <code>addListener</code> gets the name of the activation
+ * method as a parameter. The actual method is reflected from
* <code>object</code>, and unless exactly one match is found,
* <code>java.lang.IllegalArgumentException</code> is thrown.
* </p>
* </p>
*
* @param eventType
- * the type of the listened event. Events of this type or its
- * subclasses activate the listener.
+ * the type of the listened event. Events of this type or its
+ * subclasses activate the listener.
* @param object
- * the object instance who owns the activation method.
+ * the object instance who owns the activation method.
* @param methodName
- * the name of the activation method.
+ * the name of the activation method.
*/
public void addListener(Class eventType, Object object, String methodName) {
if (eventRouter == null) {
/**
* Removes all registered listeners matching the given parameters. Since
* this method receives the event type and the listener object as
- * parameters, it will unregister all <code>object</code>'s methods that
- * are registered to listen to events of type <code>eventType</code>
- * generated by this component.
+ * parameters, it will unregister all <code>object</code>'s methods that are
+ * registered to listen to events of type <code>eventType</code> generated
+ * by this component.
*
* <p>
* For more information on the inheritable event mechanism see the
* </p>
*
* @param eventType
- * the exact event type the <code>object</code> listens to.
+ * the exact event type the <code>object</code> listens to.
* @param target
- * the target object that has registered to listen to events
- * of type <code>eventType</code> with one or more methods.
+ * the target object that has registered to listen to events of
+ * type <code>eventType</code> with one or more methods.
*/
public void removeListener(Class eventType, Object target) {
if (eventRouter != null) {
* </p>
*
* @param eventType
- * the exact event type the <code>object</code> listens to.
+ * the exact event type the <code>object</code> listens to.
* @param target
- * target object that has registered to listen to events of
- * type <code>eventType</code> with one or more methods.
+ * target object that has registered to listen to events of type
+ * <code>eventType</code> with one or more methods.
* @param method
- * the method owned by <code>target</code> that's
- * registered to listen to events of type
- * <code>eventType</code>.
+ * the method owned by <code>target</code> that's registered to
+ * listen to events of type <code>eventType</code>.
*/
public void removeListener(Class eventType, Object target, Method method) {
if (eventRouter != null) {
* </p>
*
* @param eventType
- * the exact event type the <code>object</code> listens to.
+ * the exact event type the <code>object</code> listens to.
* @param target
- * the target object that has registered to listen to events
- * of type <code>eventType</code> with one or more methods.
+ * the target object that has registered to listen to events of
+ * type <code>eventType</code> with one or more methods.
* @param methodName
- * the name of the method owned by <code>target</code>
- * that's registered to listen to events of type
- * <code>eventType</code>.
+ * the name of the method owned by <code>target</code> that's
+ * registered to listen to events of type <code>eventType</code>.
*/
public void removeListener(Class eventType, Object target, String methodName) {
if (eventRouter != null) {
* Sends the event to all listeners.
*
* @param event
- * the Event to be sent to all listeners.
+ * the Event to be sent to all listeners.
*/
protected void fireEvent(Component.Event event) {
if (eventRouter != null) {
* The component does not use or modify this data.
*
* @param data
- * the Application specific data.
+ * the Application specific data.
* @since 3.1
*/
public void setData(Object data) {
*
* @see com.itmill.toolkit.terminal.Sizeable#setHeight(float)
*/
+ @Deprecated
public void setHeight(float height) {
setHeight(height, getHeightUnits());
}
*
* @see com.itmill.toolkit.terminal.Sizeable#setHeightUnits(int)
*/
+ @Deprecated
public void setHeightUnits(int unit) {
setHeight(getHeight(), unit);
}
*
* @see com.itmill.toolkit.terminal.Sizeable#setWidth(float)
*/
+ @Deprecated
public void setWidth(float width) {
setWidth(width, getWidthUnits());
}
*
* @see com.itmill.toolkit.terminal.Sizeable#setWidthUnits(int)
*/
+ @Deprecated
public void setWidthUnits(int unit) {
setWidth(getWidth(), unit);
}
* handle the exception.
*
* @param errorHandler
- * AbstractField specific error handler
+ * AbstractField specific error handler
*/
public void setErrorHandler(ComponentErrorHandler errorHandler) {
this.errorHandler = errorHandler;
* Handle the component error event.
*
* @param error
- * Error event to handle
+ * Error event to handle
* @return True if the error has been handled False, otherwise. If the error
* haven't been handled by this component, it will be handled in the
* application error handler.
projects / vaadin-framework.git / commitdiff