com.google.appinventor.components.annotations.DesignerComponent Interface Reference

Public Member Functions
ComponentCategory	category () default ComponentCategory.UNINITIALIZED
String	description () default ""
String	designerHelpDescription () default ""
boolean	showOnPalette () default true
boolean	nonVisible () default false
String	iconName () default ""
int	version ()
String	helpUrl () default ""
int	androidMinSdk () default ComponentConstants.APP_INVENTOR_MIN_SDK
String	versionName () default ""
String	dateBuilt () default ""

Detailed Description

Annotation to mark components for use in the Designer and Blocks Editor.

Definition at line 22 of file DesignerComponent.java.

Member Function Documentation

androidMinSdk()

int com.google.appinventor.components.annotations.DesignerComponent.androidMinSdk

(

)

The minimum SDK version required for the component. Defaults to the global App Inventor minimum SDK unless otherwise specified.

category()

ComponentCategory com.google.appinventor.components.annotations.DesignerComponent.category

(

)

Category within designer.

dateBuilt()

String com.google.appinventor.components.annotations.DesignerComponent.dateBuilt

(

)

A ISO 8601 datetime string that indicates when the component was built. This information will be shown in the component help popup for extensions. This is automatically populated by com.google.appinventor.components.scripts.ExternalComponentGenerator.

Returns

An ISO 8601 string containing the compilation time of the component.

description()

String com.google.appinventor.components.annotations.DesignerComponent.description

(

)

If non-empty, description to use in user-level documentation on a static web page in place of Javadoc, which is meant for developers. This may contain unescaped HTML.

designerHelpDescription()

String com.google.appinventor.components.annotations.DesignerComponent.designerHelpDescription

(

)

Description to be shown on user request in the Designer. If this field is empty, the description() field should be used. This may contain HTML. Internal double-quotes will be converted to single-quotes when this field is displayed in the designer.

helpUrl()

String com.google.appinventor.components.annotations.DesignerComponent.helpUrl

(

)

Custom help URL for the component (used for extensions).

iconName()

String com.google.appinventor.components.annotations.DesignerComponent.iconName

(

)

The file name of the icon that represents the component in the palette. This should be just the last part of the path name for the file. We'll look for the file in "com/google/appinventor/images/" for statically loaded resources, or in "war/images/" for dynamically loaded components

Returns

The name of the icon file

nonVisible()

boolean com.google.appinventor.components.annotations.DesignerComponent.nonVisible

(

)

If true, component is "non-visible" in the UI; that is, it doesn't need any special handling in the Designer and can be represented by a com.google.appinventor.client.editor.simple.components.MockNonVisibleComponent.

showOnPalette()

boolean com.google.appinventor.components.annotations.DesignerComponent.showOnPalette

(

)

If False, don't show this component on the palette. This was added to support the Form/Screen component.

version()

int com.google.appinventor.components.annotations.DesignerComponent.version

(

)

The version of the component.

versionName()

String com.google.appinventor.components.annotations.DesignerComponent.versionName

(

)

A custom version name for the component version. If provided, it will be shown in the component help popup in place of the version(). This can be useful for marking beta or release candidate versions of extensions, for example.

Returns

The custom version name, if any.

---

The documentation for this interface was generated from the following file:

• C:/Users/Ulli/appinventor-sources/appinventor/components/src/com/google/appinventor/components/annotations/DesignerComponent.java