Module omix.api

Package omix.lang.annotation

This package contains Java annotations used in OVL.
  • Annotation Types Summary 
    Annotation Type Description
    Capabilities
    This annotation defines the editability of an annotation.
    Capabilities.PropertyCapabilities  
    Editable
    This annotation defines the editability of an annotation.
    ExcludedItems
    This annotation avoids that a set if items is extended by the annotated item extension or individual field, method or accessory.
    Hidden
    This annotation avoids visibility of fields and accessories in the property list and/or in the scene.
    Icon
    An annotated field is displayed with an icon from the given path.
    Examples:
    @Icon("smile.png") CheckButton button : method(boolean);
    IncludedItems
    This annotation limits the applicabity of code to a set if items.
    Label
    Overrides the identifier of the annotated field or trigger with the denoted label.
    Two examples without Label annotation:
    NonNull
    A field annotated with @NonNull must not be null.
    ReadOnly
    Forbids editing the annotated field in the property editor of Omix.
    Suffix
    The value of the annotated member is displayed with the given unit.
    Examples:
    @Unit("m") double distance = 25.0;
    ToolTip
    Omix displays the given tooltip when the mouse hovers the property line of the annotated field or the accessory in scene or on the toolbar of the main window.
    Example:
    @ToolTip("Enter a text") String text = "";
    Unit Deprecated.
    Validating
    A field annotated with @Validating(»validator type«) is always checked by the Validator if assigned values are valid.