2. "Undeprecated" reflection based listeners, we still wish to support these.
But I noted on javadoc that using these methods is discouraged and suggested better methods.
svn changeset:3718/svn branch:trunk
package com.itmill.toolkit.terminal;
import java.util.Map;
-import java.util.Set;
/**
* <p>
* changes.
* </p>
*
- * <p>
- * The variable-owning components can be linked with <i>dependency relationships</i>.
- * A dependency between two components means that all variable change events to
- * the depended component will be handled before any such events to the
- * depending component.
- * </p>
- *
- * <p>
- * For example, the commit button for a text field will depend on that text
- * field. This is because we want to handle any pending changes the user makes
- * to the contents on the text field before we accept the click of the commit
- * button which starts processing the text field contents.
- * </p>
- *
* @author IT Mill Ltd.
* @version
* @VERSION@
*/
public interface VariableOwner {
- /**
- * Dependencies are not needed anymore as HTML-mode is deprecated in Toolkit
- * 5. *
- *
- * @return Set of <code>VariableOwners</code> this component directly
- * depend on, <code>null</code> if this component does not depend
- * on anybody.
- * @deprecated
- */
- public Set getDirectDependencies();
-
/**
* Called when one or more variables handled by the implementing class are
* changed.
*/
public void changeVariables(Object source, Map variables);
- /**
- * Dependencies are not needed anymore as HTML-mode is deprecated in Toolkit
- * 5.
- *
- * @param depended
- * the <code>VariableOwner</code> component who this
- * component depends on.
- * @deprecated
- */
- public void dependsOn(VariableOwner depended);
-
- /**
- * Dependencies are not needed anymore as HTML-mode is deprecated in Toolkit
- * 5.
- *
- * @param depended
- * the component to be removed from this component's
- * dependency list.
- * @deprecated
- */
- public void removeDirectDependency(VariableOwner depended);
-
/**
* <p>
* Tests if the variable owner is enabled or not. The terminal should not
import java.util.LinkedList;
import java.util.Locale;
import java.util.Map;
-import java.util.Set;
import com.itmill.toolkit.Application;
import com.itmill.toolkit.event.EventRouter;
import com.itmill.toolkit.terminal.PaintException;
import com.itmill.toolkit.terminal.PaintTarget;
import com.itmill.toolkit.terminal.Resource;
-import com.itmill.toolkit.terminal.VariableOwner;
/**
* An abstract class that defines default implementation for the
* here, we use the default documentation from implemented interface.
*/
public final void paint(PaintTarget target) throws PaintException {
-
if (!target.startTag(this, getTag()) || repaintRequestListenersNotified) {
// Paint the contents of the component
/* Documentation copied from interface */
public void childRequestedRepaint(Collection alreadyNotified) {
-
// Invisible components do not need repaints
if (!isVisible()) {
return;
* @param alreadyNotified
*/
private void fireRequestRepaintEvent(Collection alreadyNotified) {
-
// Notify listeners only once
if (!repaintRequestListenersNotified) {
-
// Notify the listeners
if (repaintRequestListeners != null
&& !repaintRequestListeners.isEmpty()) {
* interface.
*/
public void changeVariables(Object source, Map variables) {
-
- }
-
- /* Dependency -framework is deprecated */
- public void dependsOn(VariableOwner depended) {
- }
-
- public void removeDirectDependency(VariableOwner depended) {
- }
-
- public Set getDirectDependencies() {
- return null;
}
/* General event framework *************************************** */
/**
* <p>
- * Registers a new listener with the specified activation method to listen
- * events generated by this component. If the activation method does not
- * have any arguments the event object will not be passed to it when it's
- * called.
+ * Convenience method for registering a new listener with the specified
+ * activation method to listen events generated by this component. If the
+ * activation method does not have any arguments the event object will not
+ * be passed to it when it's called.
* </p>
*
* <p>
* {@link com.itmill.toolkit.event com.itmill.toolkit.event package documentation}.
* </p>
*
+ * <p>
+ * Note: Using this method is discouraged because it cannot be checked
+ * during compilation. Use {@link #addListener(Class, Object, Method)} or
+ * {@link #addListener(com.itmill.toolkit.ui.Component.Listener)} instead.
+ * </p>
+ *
* @param eventType
* the type of the listened event. Events of this type or its
* subclasses activate the listener.
* the object instance who owns the activation method.
* @param methodName
* the name of the activation method.
- * @deprecated Use {@link #addListener(Class, Object, Method)} or
- * {@link #addListener(com.itmill.toolkit.ui.Component.Listener)}
- * instead. Using this method is discouraged because it cannot
- * be checked during compilation.
*/
public void addListener(Class eventType, Object object, String methodName) {
if (eventRouter == null) {
* the Event to be sent to all listeners.
*/
protected void fireEvent(Component.Event event) {
-
if (eventRouter != null) {
eventRouter.fireEvent(event);
}
* implemented interface.
*/
public void addListener(Component.Listener listener) {
-
if (eventRouter == null) {
eventRouter = new EventRouter();
}
* interface.
*/
public void removeListener(Component.Listener listener) {
-
if (eventRouter != null) {
eventRouter.removeListener(Component.Event.class, listener,
COMPONENT_EVENT_METHOD);
}
/**
- * Creates a new push button with a method listening button clicks. The
- * method must have either no parameters, or only one parameter of
- * Button.ClickEvent type.
+ * Creates a new push button with a method listening button clicks. Using
+ * this method is discouraged because it cannot be checked during
+ * compilation. Use
+ * {@link #Button(String, com.itmill.toolkit.ui.Button.ClickListener)}
+ * instead. The method must have either no parameters, or only one parameter
+ * of Button.ClickEvent type.
*
* @param caption
* the Button caption.
* @param methodName
* the name of the method in target object, that receives
* button click events.
- * @deprecated Use
- * {@link #Button(String, com.itmill.toolkit.ui.Button.ClickListener)}
- * instead. Using this method is discouraged because it cannot
- * be checked during compilation.
*/
public Button(String caption, Object target, String methodName) {
this(caption);
}
/**
- * Creates a new switch button with a method listening button clicks. The
- * method must have either no parameters, or only one parameter of
+ * Convenience method for creating a new switch button with a method
+ * listening button clicks. Using this method is discouraged because it
+ * cannot be checked during compilation. Use
+ * {@link #addListener(Class, Object, Method)} or
+ * {@link #addListener(com.itmill.toolkit.ui.Component.Listener)} instead.
+ * The method must have either no parameters, or only one parameter of
* Button.ClickEvent type.
*
* @param caption
* @param methodName
* the name of the method in target object, that receives
* button click events.
- * @deprecated Use {@link #addListener(Class, Object, Method)} or
- * {@link #addListener(com.itmill.toolkit.ui.Component.Listener)}
- * instead. Using this method is discouraged because it cannot
- * be checked during compilation.
*/
public CheckBox(String caption, Object target, String methodName) {
setCaption(caption);
import java.util.LinkedList;
import java.util.Locale;
import java.util.Map;
-import java.util.Set;
import com.itmill.toolkit.Application;
import com.itmill.toolkit.terminal.PaintException;
import com.itmill.toolkit.terminal.PaintTarget;
import com.itmill.toolkit.terminal.Resource;
-import com.itmill.toolkit.terminal.VariableOwner;
/**
* Custom component provides simple implementation of Component interface for
public void changeVariables(Object source, Map variables) {
}
- /* Dependency -framework is deprecated */
- public void dependsOn(VariableOwner depended) {
- }
-
- public void removeDirectDependency(VariableOwner depended) {
- }
-
- public Set getDirectDependencies() {
- return null;
- }
-
/* Event functions are not implemented by default -------------------- */
/**
public void addField(Object propertyId, Field field) {
if (propertyId != null && field != null) {
- dependsOn(field);
fields.put(propertyId, field);
propertyIds.addLast(propertyId);
field.setReadThrough(readThrough);
if (field != null) {
propertyIds.remove(id);
fields.remove(id);
- removeDirectDependency(field);
layout.removeComponent(field);
return true;
}
// Replaces the old field with new one
layout.replaceComponent(oldField, newField);
fields.put(propertyId, newField);
- removeDirectDependency(oldField);
- dependsOn(newField);
- newField.dependsOn(this);
return newField;
}
// Sets the panel to be parent for the layout
layout.setParent(this);
- dependsOn(layout);
// If panel already contains a layout, move the contents to new one
// and detach old layout from the panel
if (this.layout != null) {
layout.moveComponentsFrom(this.layout);
- removeDirectDependency(this.layout);
this.layout.setParent(null);
}
projects / vaadin-framework.git / commitdiff