com.chemaxon.overlap.wui.res.annotations

Annotation Type ResourceInfo

@Target(value=TYPE)
 @Retention(value=RUNTIME)
public @interface ResourceInfo

Basic information about a resource class.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	description Human readable description of the resource class.
String	descriptionDetails Human readable more detailed description of the resource class.
String	icon64Url Url of a 64x64 px icon depicting the resource class.
String	landingPageUrl URL for the landing page capable of displaying the resource.
String	rootUrl Root url of the resource.
String	sizeDescription Short description of the resource size.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	landingDefaultSubResource Default sub-reosource passed for landing page.
long	precedence Precedence hint of the resource class.

Element Detail

landingPageUrl

public abstract String landingPageUrl

URL for the landing page capable of displaying the resource. URL parameter ref is passed to the landing page. The landing page link is composed as {landingPageUrl}?ref={rootUrl}/{resourceName}[/{landingDefaultSubResource}]

Returns:

Landing page URL

rootUrl

public abstract String rootUrl

Root url of the resource.

Returns:

root url

icon64Url

public abstract String icon64Url

Url of a 64x64 px icon depicting the resource class.

Returns:

Icon url

description

public abstract String description

Human readable description of the resource class.

Returns:

Resource class description

descriptionDetails

public abstract String descriptionDetails

Human readable more detailed description of the resource class. Describe the functionality of the landing page.

Returns:

More detailed description

sizeDescription

public abstract String sizeDescription

Short description of the resource size. The resource size is returned by Described.getSize(). Note that arbitrary size units can be implemented.

Returns:

Short description

landingDefaultSubResource

public abstract String landingDefaultSubResource

Default sub-reosource passed for landing page. Landing page might display different views of the represented resource. If specified this sub resource represents the default view to be displayed.

Returns:

Default sub resource

Default:

""

precedence

public abstract long precedence

Precedence hint of the resource class. Typically used to sort the listing of available resources.

Returns:

Resource class precedence

Default:

0L