uic.action
Class ComponentShownAction

java.lang.Object
  uic.model.UICSimpleAction
      uic.action.SwingAction
          uic.action.ComponentShownAction

All Implemented Interfaces:

ComponentListener, EventListener

public class ComponentShownAction
extends SwingAction
implements ComponentListener

An event to respond to a widget being shown on screen. This action fires one time per widget added to it. You will find this action most usefull in a constructor of a widget which must do something that it can only do if the widget is fully showing on screen. Notice that the default version uses the DirectPolicy. Using this class is easy; just call:

new ComponentShownAction(this, "firedSlot").add(childComponent); 

This has the result that as soon as the Window that contains the component you added is made visible 'firedSlot' on object 'this' will be called.

Default target signatures

(ARGUMENT_SOURCE)
()

All Targets

ARGUMENT_SOURCE

Since:

2.0

See Also:

Component.isShowing()

Nested Class Summary

Nested classes/interfaces inherited from class uic.model.UICSimpleAction

UICSimpleAction.Arguments, UICSimpleAction.DirectMultiThreadingPolicy, UICSimpleAction.DirectPolicy, UICSimpleAction.ExecutePolicy, UICSimpleAction.OnlyLastPolicy, UICSimpleAction.QueuedPolicy, UICSimpleAction.SimpleQueuedPolicy

Field Summary

static String

ARGUMENT_SOURCE an Object: the source object that threw the event

Fields inherited from class uic.action.SwingAction

updateUICommmand

Fields inherited from class uic.model.UICSimpleAction

currentPolicy, target, targetObject

Constructor Summary

ComponentShownAction(Object targetObject, String targetMethod)
Create a new ComponentShownAction.

ComponentShownAction(Object targetObject, String targetMethod, UICSimpleAction.Arguments arguments)
Create a new ComponentShownAction.

Method Summary

ComponentShownAction	add(Component source) Add an Component object to this action.
void	componentHidden(ComponentEvent e)
void	componentMoved(ComponentEvent e)
void	componentResized(ComponentEvent e)
void	componentShown(ComponentEvent e)
protected Class	getArgumentClass(String argumentType) For the uniquely defined argumentType (as also used in UICSimpleAction.getTargetSignatures()) return the Class.
protected Object	getArgumentValue(EventObject source, String argumentType) For the uniquely defined argumentType (as also used in UICSimpleAction.getTargetSignatures()) return the value.
protected List	getTargetSignatures() Return a List object with instances of the Arguments class.

Methods inherited from class uic.action.SwingAction

doAction, getComponentsIterator, registerComponent, setEnabled, setUIUpdateCommand, setUIUpdateCommand

Methods inherited from class uic.model.UICSimpleAction

createArguments, equals, execute, execute, execute, execute, isEnabled, setDirect, setExecutionPolicy, setTarget, setTarget

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ARGUMENT_SOURCE

public static final String ARGUMENT_SOURCE

an Object: the source object that threw the event

See Also:

Constant Field Values

Constructor Detail

ComponentShownAction

public ComponentShownAction(Object targetObject,
                            String targetMethod)

Create a new ComponentShownAction.

Parameters:

targetObject - on which object should the target method be invoked

targetMethod - wich method on the targetObject should be invoked

ComponentShownAction

public ComponentShownAction(Object targetObject,
                            String targetMethod,
                            UICSimpleAction.Arguments arguments)

Create a new ComponentShownAction.

Parameters:

targetObject - on which object should the target method be invoked

targetMethod - wich method on the targetObject should be invoked

arguments - to be used in finding the targetMethod signature

See Also:

UICSimpleAction.setTarget(Object,String,uic.model.UICSimpleAction.Arguments)

Method Detail

add

public ComponentShownAction add(Component source)

Add an Component object to this action.

Parameters:

source - the component that will be become visible later.

getTargetSignatures

protected List getTargetSignatures()

Description copied from class: UICSimpleAction

Return a List object with instances of the Arguments class. Extending classes should implement this to return all the target method signatures that are searched for should the user create an action without an Arguments instance.

An example implementation could be this:

  List result = new ArrayList(1);
  result.add( new Arguments().addArgument("Source") );
  return result;

This will result in a call to UICSimpleAction.getArgumentClass(java.lang.String) with the string "Source" which returns a Class instance. In our example that would be java.lang.Object.

The result of this would be that a call to setTarget will try to find a method with an argument of type Object, and will search again if that is not found without any arguments.

Overrides:

getTargetSignatures in class UICSimpleAction

Returns:

a List object with instances of the Arguments class.

See Also:

UICSimpleAction.getArgumentValue(java.util.EventObject, java.lang.String), UICSimpleAction.getArgumentClass(java.lang.String)

getArgumentValue

protected Object getArgumentValue(EventObject source,
                                  String argumentType)

Description copied from class: UICSimpleAction

For the uniquely defined argumentType (as also used in UICSimpleAction.getTargetSignatures()) return the value. This method will always return 'null'; Extending actions can define various argumentType strings that can be used as an argument in the call to the target method of this action. The user decides on construction of the action which argumentTypes are to be used, if a certain value is requested to be sent to the targetMethod a call is made to this method to find its value based on the source event.

Note that base types can not be returned, since they are instances of object; you should wrap these in their object re-presentation (an Integer object for an int).

Overrides:

getArgumentValue in class UICSimpleAction

Parameters:

source - the event that caused the action to be fired. This is the event that the extending class passed to the execute method; so casting is fine.

argumentType - the uniquely defined name specifying the type of argument.

Returns:

the value to be passed to the taget method.

getArgumentClass

protected Class getArgumentClass(String argumentType)

Description copied from class: UICSimpleAction

For the uniquely defined argumentType (as also used in UICSimpleAction.getTargetSignatures()) return the Class. This method will always return 'null'; Extending actions can define various argumentType strings that can be used as an argument in the call to the target method of this action. The user decides on construction of the action which argumentTypes are to be used, if a certain value is requested to be sent to the targetMethod a call is made to this method to find the Class of the type.

Note that basetypes have a class of their own and you should return the correct one you expect the targetMethod to implement. returning Integer.class will search for an Integer; returing int.class will search for an int. This is important to note since the UICSimpleAction.getArgumentValue(java.util.EventObject, java.lang.String) method should return an Integer object in both cases.

Overrides:

getArgumentClass in class UICSimpleAction

Parameters:

argumentType - the uniquely defined name specifying the type of argument.

Returns:

the class of this argument to be found on the target method

componentHidden

public void componentHidden(ComponentEvent e)

Specified by:

componentHidden in interface ComponentListener

componentMoved

public void componentMoved(ComponentEvent e)

Specified by:

componentMoved in interface ComponentListener

componentResized

public void componentResized(ComponentEvent e)

Specified by:

componentResized in interface ComponentListener

componentShown

public void componentShown(ComponentEvent e)

Specified by:

componentShown in interface ComponentListener