io.jmix.ui.meta

Annotation Type StudioComponent

@Documented
public @interface StudioComponent

Indicates that the annotated UI component interface should be available in Studio Screen Designer. Provides metadata for Component Palette and Component Inspector of Screen Designer. The annotated interface must be a direct or indirect subclass of Component.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
CanvasBehaviour	canvasBehaviour
java.lang.String	canvasIcon Specifies path to the UI component icon shown on canvas as a placeholder, SVG or PNG.
CanvasIconSize	canvasIconSize
java.lang.String	canvasText Specifies text that will be shown on a canvas for the UI component E.g.
java.lang.String	canvasTextProperty Specifies name of the component property that provides value that will be used as canvasText().
java.lang.String	caption
java.lang.String	category
ContainerType	containerType
java.lang.String	defaultProperty
java.lang.String	description
java.lang.String	documentationURL Specifies URL pointing to the documentation page for the annotated UI component.
java.lang.String	icon Specifies path to the component icon, SVG or PNG.
java.lang.String[]	unsupportedProperties
java.lang.String	xmlElement
java.lang.String	xmlns Specifies xml namespace required for the component.
java.lang.String	xmlnsAlias Specifies xml namespace alias required for the component.

Element Detail

caption

public abstract java.lang.String caption

Returns:

caption in Studio Screen Designer Palette

Default:

""

description

public abstract java.lang.String description

Returns:

description of the component in Studio Screen Designer Palette

Default:

""

category

public abstract java.lang.String category

Returns:

category of the component in Studio Screen Designer Palette, e.g. Containers, Components, Fields

Default:

""

icon

public abstract java.lang.String icon

Specifies path to the component icon, SVG or PNG. Relative to the component module root. The icon used in the Component Palette and Component Hierarchy.

Returns:

relative path to the SVG or PNG icon file.

Default:

""

xmlElement

public abstract java.lang.String xmlElement

Returns:

XML tag of the component

Default:

""

xmlns

public abstract java.lang.String xmlns

Specifies xml namespace required for the component.

Returns:

xml namespace

Default:

""

xmlnsAlias

public abstract java.lang.String xmlnsAlias

Specifies xml namespace alias required for the component.

Returns:

xml namespace alias

Default:

""

defaultProperty

public abstract java.lang.String defaultProperty

Returns:

name of the default property, it will be automatically selected in Properties panel

Default:

""

unsupportedProperties

public abstract java.lang.String[] unsupportedProperties

Returns:

names of unsupported properties that should be hidden from Properties panel

Default:

{}

canvasIcon

public abstract java.lang.String canvasIcon

Specifies path to the UI component icon shown on canvas as a placeholder, SVG or PNG. Relative to the component module root. Used if canvasBehaviour() is CanvasBehaviour.BOX.

Returns:

relative path to the SVG or PNG icon file.

Default:

""

canvasIconSize

public abstract CanvasIconSize canvasIconSize

Returns:

size of the icon shown on canvas as a placeholder.

Default:

io.jmix.ui.meta.CanvasIconSize.SMALL

canvasText

public abstract java.lang.String canvasText

Specifies text that will be shown on a canvas for the UI component E.g. button caption for CanvasBehaviour.BUTTON component

Default:

""

canvasTextProperty

public abstract java.lang.String canvasTextProperty

Specifies name of the component property that provides value that will be used as canvasText(). If property value is not set then canvasText() attribute value will be used

Default:

""

canvasBehaviour

public abstract CanvasBehaviour canvasBehaviour

Returns:

behaviour of UI component on Screen designer canvas

Default:

io.jmix.ui.meta.CanvasBehaviour.BOX

containerType

public abstract ContainerType containerType

Returns:

type of container layout if canvasBehaviour() is CanvasBehaviour.CONTAINER

Default:

io.jmix.ui.meta.ContainerType.VERTICAL

documentationURL

public abstract java.lang.String documentationURL

Specifies URL pointing to the documentation page for the annotated UI component. Used in Jmix Documentation action in the Studio Screen Designer.
If the documentation is version dependent, use %VERSION% as a placeholder. It will be replaced with the minor version (e.g. 1.2) of the artifact containing UI component.

Returns:

URL of the documentation page

Default:

""