org.tentackle.fx.rdc.PdoTableContextMenuItemService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of tentackle-fx-rdc Show documentation

Rich Desktop Client based on FX

There is a newer version: 21.16.1.0

/**
 * Tentackle - http://www.tentackle.org
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */


package org.tentackle.fx.rdc;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import org.tentackle.common.MappedService;
import org.tentackle.pdo.PersistentDomainObject;


/**
 * Annotation to express that the annotated class is a {@link PdoTableContextMenuItem}.
 */
@Documented
@Inherited
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@MappedService(PdoTableContextMenuItem.class)
public @interface PdoTableContextMenuItemService {

  /**
   * Determines the serviced PDO class.

   * The PDO-class usually is an interface extending the persistent
   * and the domain interfaces.
   * 
   * The class may be also a super-interface. For example,
   * PersistentDomainObject will apply to all PDOs.
   *
   * @return the PDO class
   */
  Class value();

  /**
   * The ordinal to sort the menu-items within the context menu.

   * 0 comes first.
   * 
   * If the same ordinal is defined more than once, the menu item closest
   * in the the PDO-inheritance tree will override all others.
   *
   * @return the ordinal
   */
  int ordinal();

  /**
   * Defines the group the item belongs to.

   * Separators will be inserted between groups.
   *
   * @return the group, empty for default group
   */
  String group() default "";

}