Package org.kuali.rice.krad.uif.field

Interface Field

All Superinterfaces:
Cloneable, Component, Copyable, DictionaryBean, LifecycleElement, Ordered, org.springframework.core.Ordered, ScriptEventSupport, Serializable, UifDictionaryBean
All Known Subinterfaces:
DataField, InputField
All Known Implementing Classes:
ActionField, DataFieldBase, FieldBase, FieldGroup, GenericField, GroupLinkField, ImageField, InputFieldBase, LinkField, LookupInputField, MessageField, ProgressBarField, RoleLinkField, SpaceField, UserLinkField
public interface Field extends Component
Component that contains one or more user interface elements and can be placed into a Container

Provides a wrapper for various user interface elements so they can be treated uniformly by a container and rendered using a LayoutManager. Implementations exist for various types of elements and properties to configure that element.

Author:
Kuali Rice Team (rice.collab@kuali.org)

  • Method Details

    • getLabel

      String getLabel()
      Label text for the field

      The label is generally used to identify the field in the user interface

      Returns:
      String label text

    • setLabel

      void setLabel(String labelText)
      Setter for the field's label text

    • getShortLabel

      String getShortLabel()
      Short label for the field

      For areas of the user interface that have limited area (such as table headers), the short label can be used to identify the field

      Returns:
      String short label

    • setShortLabel

      void setShortLabel(String shortLabel)
      Setter for the field's short label text
      Parameters:
      shortLabel -

    • getFieldLabel

      Label getFieldLabel()
      Label instance for the field

      The label field contains the labeling text for the field in addition to configuration for rendering in the user interface (such as the styling for the label area)

      Returns:
      Label instance

    • setFieldLabel

      void setFieldLabel(Label label)
      Setter for the field's label field

    • isLabelLeft

      boolean isLabelLeft()
      The label for this field will be positioned to the left of the field content, when true.

      The usage of this option is for one-off instances in which a label must be positioned to the left of a field for layout purposes. It is recommended that if many fields will have their labels positioned to the left in a group that a CssGridLabelColumnLayoutManager backed group be used instead.

    • setLabelLeft

      void setLabelLeft(boolean labelLeft)
      See Also:

    • isLabelRendered

      boolean isLabelRendered()
      Indicates whether the contained Label has been rendered as part of another field and thus should not be rendered with the attribute
      Returns:
      boolean true if the label field has been rendered, false if it should be rendered with the attribute

    • setLabelRendered

      void setLabelRendered(boolean labelFieldRendered)
      Setter for the label field rendered indicator

    • getLabelStyleClasses

      List<String> getLabelStyleClasses()
      Label style classes for the field
      Returns:
      List<String> label style classes

    • setLabelStyleClasses

      void setLabelStyleClasses(List<String> labelStyleClasses)
      Setter for the field's label style classes

    • getLabelColSpan

      int getLabelColSpan()
      Label column span for the field
      Returns:
      int label column span

    • setLabelColSpan

      void setLabelColSpan(int labelColSpan)
      Setter for the field's label column span

    • getFieldSecurity

      FieldSecurity getFieldSecurity()
      Field Security object that indicates what authorization (permissions) exist for the field
      Returns:
      FieldSecurity instance