DesignerComponent.java

Go to the documentation of this file.

// -*- mode: java; c-basic-offset: 2; -*-
// Copyright 2009-2011 Google, All Rights reserved
// Copyright 2011-2018 MIT, All rights reserved
// Released under the Apache License, Version 2.0
// http://www.apache.org/licenses/LICENSE-2.0
 
package com.google.appinventor.components.annotations;
 
import com.google.appinventor.components.common.ComponentCategory;
import com.google.appinventor.components.common.ComponentConstants;
 
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
 
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface DesignerComponent {
  ComponentCategory category() default ComponentCategory.UNINITIALIZED;
 
  String description() default "";
 
  // TODO(user): Add more robust character escaping.
  String designerHelpDescription() default "";
 
  boolean showOnPalette() default true;
 
  boolean nonVisible() default false;
 
  String iconName() default "";
 
  // Constants for all component version numbers must be defined in
  // com.google.appinventor.components.common.YaVersion, and specified when the DesignerComponent
  // annotation is used.
  int version(); // There is no default value.
 
  String helpUrl() default "";
 
  int androidMinSdk() default ComponentConstants.APP_INVENTOR_MIN_SDK;
 
  String versionName() default "";
 
  String dateBuilt() default "";
}