Annotation Type HelpDef


  • @Target(METHOD)
    @Retention(RUNTIME)
    public @interface HelpDef
    Annotation that describes property help message.
    Since:
    1.0
    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      boolean afterValue
      show position, after property value.
      DeviceType[] device
      The device types for which the help is enabled.
      boolean dynamic
      static or dynamic message
      boolean force
      Whether to force displaying message even if in show mode
      java.lang.String message
      help message for user, not localized.
      boolean popup
      Whether to popup a message as tooltip? Valid only if toggleable is true.
      boolean toggleable
      Whether the help can be hidden and shown? If false, the help will be shown statically.
      ViewType[] view
      the view type in which the help will be shown.
    • Element Detail

      • message

        java.lang.String message
        help message for user, not localized. empty: no help.
        Default:
        ""
      • toggleable

        boolean toggleable
        Whether the help can be hidden and shown? If false, the help will be shown statically.
        Since:
        5.15
        Default:
        true
      • popup

        boolean popup
        Whether to popup a message as tooltip? Valid only if toggleable is true. if true, popup help. Otherwise, display help in place.
        Default:
        true
      • dynamic

        boolean dynamic
        static or dynamic message
        Returns:
        true for dynamic. default is false.
        Default:
        false
      • force

        boolean force
        Whether to force displaying message even if in show mode
        Returns:
        true if forcing. default is false.
        Default:
        false
      • view

        ViewType[] view
        the view type in which the help will be shown. default: all views.
        Default:
        {com.cmobilecom.af.model.bean.ViewType.ALL}
      • afterValue

        boolean afterValue
        show position, after property value. default is true.
        Default:
        true
      • device

        DeviceType[] device
        The device types for which the help is enabled. Default: all types of devices.
        Since:
        5.6
        Default:
        {com.cmobilecom.af.model.annotation.DeviceType.ALL}