Annotation Type ResourceSample



  • @Retention(value=RUNTIME)
    public @interface ResourceSample
    This is used by the CreateSamplesJob to apply screenshots/animations to javadocs.
    • Required Element Summary

      Required Elements

      Modifier and Type Required Element and Description
      String[] sample
      An array of strings used to construct a particular resource.
    • Optional Element Summary

      Optional Elements

      Modifier and Type Optional Element and Description
      int columnCount
      This is the number of columns to show if the samples are presented in a table.
      String[] columnNames
      An optional list of column names for table data.
      String[] names
      Return a list of the names of the samples provided.
      String[] rowNames
      An optional list of row names for table data.
      String tableIntroduction
      The text that precedes the table of samples.
    • Element Detail

      • sample

        public abstract String[] sample
        An array of strings used to construct a particular resource.

        For example: "new com.bric.swing.resources.TriangleIcon( 24, 24, new Color( 0 ) )"

        This is something that com.bric.reflect.Reflection#parse(String) is capable of parsing.

      • names

        public abstract String[] names
        Return a list of the names of the samples provided. There should be a 1:1 correspondence for every sample provided. By default this returns an empty array, which indicates that nothing will be labeled.
        Default:
        {}
      • columnCount

        public abstract int columnCount
        This is the number of columns to show if the samples are presented in a table. The default value is 4.
        Default:
        4
      • rowNames

        public abstract String[] rowNames
        An optional list of row names for table data.
        Default:
        {}
      • columnNames

        public abstract String[] columnNames
        An optional list of column names for table data.
        Default:
        {}
      • tableIntroduction

        public abstract String tableIntroduction
        The text that precedes the table of samples. The default value is "Here are some samples:"
        Default:
        "Here are some samples:"