com.jgoodies.binding.binder.ActionObjectBinder Maven / Gradle / Ivy
Show all versions of jgoodies-binding Show documentation
/*
* Copyright (c) 2012 JGoodies Karsten Lentzsch. All Rights Reserved.
*
* This software is the proprietary information of JGoodies Karsten Lentzsch.
* Use is subject to license terms.
*
*/
package com.jgoodies.binding.binder;
/**
* Adds binding capabilities for Action names to its super interface
* that can already bind Action instances.
*
* The JGoodies Binding library doesn't ship an implementation for this
* interface, because there's no popular and public standard that describes
* and implements how to look up an Action for a name.
* A popular approach is the JSR 296 (Swing Application Framework)
* that enables developers to annotate methods with @Action
* that then can be requested for a target object and an action name.
*
* Since the JGoodies implementation of the JSR 296 (the JGoodies
* "Application" library) is not available to the general public,
* the JGoodies Application-based implementation of this interface
* is not part of the Binding library.
*
* However, this interface reduce the effort to integrate your custom
* Action-lookup and binder mechanism that may be based on the JSR 296 or
* any other Action name registry.
*
* @author Karsten Lentzsch
* @version $Revision: 1.1 $
*/
public interface ActionObjectBinder extends ObjectBinder {
/**
* Looks up an Action for this binder and the given action name.
* Then creates and returns a binding builder that manages an Action that
* can be operated on and that can be bound to a button or text field.
*
* Examples:
* binder.bindAction("edit") .to(editButton);
* binder.bindAction(ACTION_EDIT).to(editButton);
*
* Implementations will typically look up an Action for a given action name
* and hand it over to {@link ObjectBinder#bind(javax.swing.Action)}.
*
* @param actionName the name of the Action to be bound
*
* @return the binding builder that holds the Action
*
* @throws NullPointerException if {@code actionName} if {@code null}
*/
ActionBindingBuilder bindAction(String actionName);
}