Package com.levigo.jadice.annotation

Class ChecklistAnnotation

java.lang.Object
com.levigo.jadice.annotation.Annotation
com.levigo.jadice.annotation.ShapeBasedAnnotation
com.levigo.jadice.annotation.RectangleAnnotation
com.levigo.jadice.annotation.ChecklistAnnotation
All Implemented Interfaces:
PermissionsProvider<Annotation>, PropertiesProvider, com.levigo.jadice.web.shared.model.annotation.internal.JwtAnnotation, Serializable, org.jadice.util.base.MementoOriginator
public class ChecklistAnnotation extends RectangleAnnotation
An Annotation consisting of 0-n checkbox elements. Each checkbox element can be toggled individually to one of the CheckboxStates (INDETERMINATE, CHECKED, UNCHECKED). Note
This is a custom implementation of a Checklist and the Jadice Webtoolkit does not provide any renderers or wranglers for this annotation type.
See Also:

  • Constructor Details

    • ChecklistAnnotation

      public ChecklistAnnotation()

  • Method Details

    • getOrientation

      public ChecklistAnnotation.Orientation getOrientation()
      Returns the orientation of this annotation.
      Returns:
      the orientation

    • setOrientation

      public void setOrientation(ChecklistAnnotation.Orientation orientation)
      Sets the orientation for this annotation.
      Parameters:
      orientation - the orientation of this annotation

    • getCheckboxes

      public List<ChecklistAnnotation.CheckboxState> getCheckboxes()
      Returns a list containing the checkbox states.
      Returns:
      the list of checkbox states

    • setCheckboxes

      public void setCheckboxes(List<ChecklistAnnotation.CheckboxState> checkboxes)
      Sets the list of checkboxes to the given list.
      Parameters:
      checkboxes - the list of checkbox elements

    • setCheckboxCSV

      @Deprecated public void setCheckboxCSV(String checkboxCSV)
      Deprecated.
      Deprecated: Use setCheckboxes(List) instead. Utility method used in the read/write process of this annotation. The list of checkboxes is transported via a CSV String.

      The values separated by the comma (,) are the names of the CheckboxState-enum.

      Parameters:
      checkboxCSV - the CSV describing the checkbox states

    • getCheckboxCSV

      @Deprecated public String getCheckboxCSV()
      Deprecated.
      Deprecated: Use getCheckboxes() instead. Utility method used in the read/write process of this annotation. The list of checkboxes is transported via a CSV String.
      Returns:
      a CSV String containing names of the CheckboxState-enum.

    • copyAttributesTo

      protected void copyAttributesTo(Annotation annotation)
      Overrides:
      copyAttributesTo in class RectangleAnnotation

    • clone

      public ChecklistAnnotation clone()
      Overrides:
      clone in class Annotation

    • copy

      public ChecklistAnnotation copy()
      Specified by:
      copy in interface com.levigo.jadice.web.shared.model.annotation.internal.JwtAnnotation
      Overrides:
      copy in class RectangleAnnotation

    • setOrientationString

      @Deprecated public void setOrientationString(String orientation)
      Deprecated.
      Deprecated: use setOrientation(Orientation) instead. Convenience method used to set the orientation via a String. This is used in Annotation Readers/Writers to store the orientation as String in XML.

      The value must be the name of one of the enum values from Orientation.

      Parameters:
      orientation - the orientation to set

    • getOrientationString

      @Deprecated public String getOrientationString()
      Deprecated.
      Deprecated: Use getOrientationString() instead. Returns the orientation as String. This is used in Annotation Readers/Writers to store the orientation as String in XML.
      Returns:
      the orientation as String