org.openide.awt 7.39.1

org.openide.awt
Annotation Type ActionReference


@Retention(value=SOURCE)
@Target(value={TYPE,FIELD,METHOD})
public @interface ActionReference

Registers an action under associated identifier specified by separate ActionID annotation on the same element. Usually it is used together with ActionRegistration. You can place your action reference into any path, here are few typical locations:

Since:
7.27

Required Element Summary
 String path
          Into which location one wants to place the reference? Translates to FileUtil.getConfigFile(java.lang.String).
 
Optional Element Summary
 ActionID id
          Identification of the action this reference shall point to.
 String name
          One can specify name of the reference.
 int position
          Position in the location.
 int separatorAfter
          Shall a separator be placed after the action?
 int separatorBefore
          Shall a separator be placed before the action?
 

Element Detail

path

public abstract String path
Into which location one wants to place the reference? Translates to FileUtil.getConfigFile(java.lang.String).

position

public abstract int position
Position in the location.

Default:
2147483647

id

public abstract ActionID id
Identification of the action this reference shall point to. Usually this is specified as ActionID peer annotation, but in case one was to create references to actions defined by someone else, one can specify the id() here.

Default:
@org.openide.awt.ActionID(id="", category="")

name

public abstract String name
One can specify name of the reference. This is not necessary, then it is deduced from associated ActionID.

Default:
""

separatorBefore

public abstract int separatorBefore
Shall a separator be placed before the action?

Returns:
position that is lower than position()
Default:
2147483647

separatorAfter

public abstract int separatorAfter
Shall a separator be placed after the action?

Returns:
position that is higher than position()
Default:
2147483647

org.openide.awt 7.39.1

Built on December 7 2011.  |  Portions Copyright 1997-2011 Oracle. All rights reserved.