org.cruxframework.crux.plugin.gadget.client.meta
Annotation Type GadgetInfo.ModulePrefs

@Retention(value=RUNTIME)
@Target(value=TYPE)
public static @interface GadgetInfo.ModulePrefs

Defines the preferences associated with the gadget.

Optional Element Summary

String	author_aboutme For the authors page, a statement about yourself (try to keep to ~500 characters).
String	author_affiliation For the authors page, an optional string such as "Google" that indicates the author's affiliation.
String	author_email Optional string that provides the gadget author's email address.
String	author_link For the authors page, a link to your website, blog, etc.
String	author_location The author's geographical location, such as "Mountain View, CA, USA ".
String	author_photo For the authors page, a URL to a photo (70x100 PNG format preferred, but JPG/GIF are also supported).
String	author_quote For the authors page, a quote you'd like to include (try to keep to ~300 characters).
String	author Optional string that lists the author of the gadget.
String	category Optional string that tells the gadget category.
String	category2 Optional string that tells the gadget secondary category.
String	description Optional string that describes the gadget.
String	directory_title Optional string that provides the title that should be displayed for your gadget in the content directory.
int	height Optional positive integer that specifies the height of the area in which the gadget runs.
String	icon The icon property specifies a 16px x 16px image that containers can associate with a particular gadget (for example, the container might display the icon next to the gadget's name in the left nav bar).
GadgetInfo.GadgetLocale[]	locales Specify gadget locale support
boolean	scaling Optional boolean that specifies whether the aspect ratio (height-to-width ratio) of the gadget is maintained when the browser is resized.
String	screenshot Optional string that gives the URL of a gadget screenshot.
boolean	scrolling Optional boolean that provides vertical and/or horizontal scrollbars if the content exceeds the space provided.
boolean	singleton Optional boolean that specifies whether users can add a gadget multiple times from a directory.
String	thumbnail Optional string that gives the URL of a gadget thumbnail.
String	title_url Optional string that provides a URL that the gadget title links to.
String	title Optional string that provides the title of the gadget.
int	width Optional positive integer that specifies the width of the area in which the gadget runs.

author

public abstract String author

Optional string that lists the author of the gadget.

Default:

""

author_aboutme

public abstract String author_aboutme

For the authors page, a statement about yourself (try to keep to ~500 characters).

Default:

""

author_affiliation

public abstract String author_affiliation

For the authors page, an optional string such as "Google" that indicates the author's affiliation. This attribute is required for gadgets that are included in the content directory.

Default:

""

author_email

public abstract String author_email

Optional string that provides the gadget author's email address. You can use any email system, but you should not use a personal email address because of spam. One approach is to use an email address of the form helensmith.feedback+coolgadget@gmail.com in your gadget spec. Gmail drops everything after the plus sign (+), so this email address is interpreted as helensmith.feedback@gmail.com.

Default:

""

author_link

public abstract String author_link

For the authors page, a link to your website, blog, etc.

Default:

""

author_location

public abstract String author_location

The author's geographical location, such as "Mountain View, CA, USA ".

Default:

""

author_photo

public abstract String author_photo

For the authors page, a URL to a photo (70x100 PNG format preferred, but JPG/GIF are also supported).

Default:

""

author_quote

public abstract String author_quote

For the authors page, a quote you'd like to include (try to keep to ~300 characters).

Default:

""

category

public abstract String category

Optional string that tells the gadget category.

Default:

""

category2

public abstract String category2

Optional string that tells the gadget secondary category.

Default:

""

description

public abstract String description

Optional string that describes the gadget.

Default:

""

directory_title

public abstract String directory_title

Optional string that provides the title that should be displayed for your gadget in the content directory. Should contain only the literal text to be displayed, not user preference substitution variables. This is because the content directory displays a static view of your gadget, and therefore can't perform the necessary substitution to produce a reasonable title. For example, if your gadget's title is "Friends for __UP_name__", the directory is not able to perform the substitution to provide a reasonable value for " __UP_name__". So you might set your directory_title to be simply "Friends".

Default:

""

height

public abstract int height

Optional positive integer that specifies the height of the area in which the gadget runs. The default height is 200.

Default:

200

icon

public abstract String icon

The icon property specifies a 16px x 16px image that containers can associate with a particular gadget (for example, the container might display the icon next to the gadget's name in the left nav bar).

Returns:

Default:

""

locales

public abstract GadgetInfo.GadgetLocale[] locales

Specify gadget locale support

Default:

{}

scaling

public abstract boolean scaling

Optional boolean that specifies whether the aspect ratio (height-to-width ratio) of the gadget is maintained when the browser is resized. Gadgets that can automatically scale vertically should set this to true, but gadgets which have a fixed height should set this to false.

Default:

true

screenshot

public abstract String screenshot

Optional string that gives the URL of a gadget screenshot. This must be an image on a public web site that is not blocked by robots.txt. PNG is the preferred format, though GIF and JPG are also acceptable. Gadget screenshots should be 280 pixels wide. The height of the screenshot should be the "natural" height of the gadget when it's in use. For more discussion of screenshot guidelines, see Publishing to the Content Directory.

Default:

""

scrolling

public abstract boolean scrolling

Optional boolean that provides vertical and/or horizontal scrollbars if the content exceeds the space provided. If false, then the content is clipped to the height and width provided (not that width is not configurable).

Default:

false

singleton

public abstract boolean singleton

Optional boolean that specifies whether users can add a gadget multiple times from a directory. The default is true, meaning that by default, gadgets can only be added once. Directories can handle this attribute however they choose. For example, the content directory handles singleton="true" by graying out and displaying the text "Added" for gadgets that have already been added. Note that changes to this attribute may not be picked up by directories right away. This attribute doesn't prevent users from adding gadgets multiple times through the developer gadget or Add by URL. Consequently, you still need to write your gadget to support multiple instances.

Default:

true

thumbnail

public abstract String thumbnail

Optional string that gives the URL of a gadget thumbnail. This must be an image on a public web site that is not blocked by robots.txt. PNG is the preferred format, though GIF and JPG are also acceptable. Gadget thumbnails should be 120x60 pixels. For more discussion of thumbnail guidelines, see Publishing to the Content Directory.

Default:

""

title

public abstract String title

Optional string that provides the title of the gadget. This title is displayed in the gadget title bar on iGoogle. If this string contains user preference substitution variables and you are planning to submit your gadget to the content directory, you should also provide a directory_title for directory display.

Default:

""

title_url

public abstract String title_url

Optional string that provides a URL that the gadget title links to. For example, you could link the title to a webpage related to the gadget.

Default:

""

width

public abstract int width

Optional positive integer that specifies the width of the area in which the gadget runs. This setting only applies to syndicated gadgets.

Default:

320