org.diylc.core.annotations
Annotation Type ComponentDescriptor

@Retention(value=RUNTIME)
public @interface ComponentDescriptor

Annotation for IDIYComponent implementation. Describes component properties.

Author:

Branislav Stojkovic

Required Element Summary

java.lang.String	author
java.lang.String	category
java.lang.String	description
java.lang.String	instanceNamePrefix
java.lang.String	name
double	zOrder

Optional Element Summary

boolean	autoEdit
BomPolicy	bomPolicy
CreationMethod	creationMethod
boolean	flexibleZOrder
KeywordPolicy	keywordPolicy
boolean	rotatable
boolean	stretchable

Element Detail

name

public abstract java.lang.String name

Returns:

component type name.

description

public abstract java.lang.String description

Returns:

component type description.

category

public abstract java.lang.String category

Returns:

component category, e.g. "Passive", "Semiconductors", etc.

author

public abstract java.lang.String author

Returns:

component author name.

instanceNamePrefix

public abstract java.lang.String instanceNamePrefix

Returns:

prefix that will be used to generate component instance names, e.g. "R" for resistors or "Q" for transistors.

zOrder

public abstract double zOrder

Returns:

Z-order of the component.

creationMethod

public abstract CreationMethod creationMethod

Returns:

method that should be used to create a component. If CreationMethod.POINT_BY_POINT is used, user will have to select ending points before the component is created.

Default:

org.diylc.core.CreationMethod.SINGLE_CLICK

flexibleZOrder

public abstract boolean flexibleZOrder

Returns:

true if the component may go beyond it's predefined layer. In that case, zOrder is used as initial z order of the component.

Default:

false

stretchable

public abstract boolean stretchable

Returns:

when false, moving one control point will cause all the others to move together with it.

Default:

true

bomPolicy

public abstract BomPolicy bomPolicy

Returns:

controls what should be shown the BOM

Default:

org.diylc.core.annotations.BomPolicy.SHOW_ALL_NAMES

autoEdit

public abstract boolean autoEdit

Returns:

when true, component editor dialog should be shown in Auto-Edit mode.

Default:

true

rotatable

public abstract boolean rotatable

Returns:

true if component may be rotated, false otherwise

Default:

true

keywordPolicy

public abstract KeywordPolicy keywordPolicy

Default:

org.diylc.core.annotations.KeywordPolicy.NEVER_SHOW