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

Class ImageField

java.lang.Object
org.kuali.rice.krad.datadictionary.DictionaryBeanBase
org.kuali.rice.krad.datadictionary.uif.UifDictionaryBeanBase
org.kuali.rice.krad.uif.component.ComponentBase
org.kuali.rice.krad.uif.field.FieldBase
org.kuali.rice.krad.uif.field.ImageField
All Implemented Interfaces:
Serializable, Cloneable, Copyable, DictionaryBean, UifDictionaryBean, Component, Ordered, ScriptEventSupport, Field, LifecycleElement, org.springframework.core.Ordered
public class ImageField extends FieldBase
Field that wraps an image content element.

Puts a <DIV> tag around an image element. This allows for labeling, styling, etc.

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

  • Constructor Details

    • ImageField

      public ImageField()

  • Method Details

    • performFinalize

      public void performFinalize(Object model, LifecycleElement parent)
      PerformFinalize override - calls super, corrects the field's Label for attribute to point to this field's content
      Specified by:
      performFinalize in interface LifecycleElement
      Overrides:
      performFinalize in class FieldBase
      Parameters:
      model - the model
      parent - the parent component

    • getImage

      public Image getImage()
      Retrieves the Image element wrapped by this field
      Returns:
      the Image element representing the HTML IMG element

    • setImage

      public void setImage(Image image)
      Sets the Image to be wrapped by this field
      Parameters:
      image - the Image element to be wrapped by this field

    • getSource

      public String getSource()
      Retrieves the URL the image wrapped by this field
      Returns:
      the URL for the image
      See Also:

    • setSource

      public void setSource(String source)
      Sets the source URL for the Image associated with this field
      Parameters:
      source - URL for the image

    • getAltText

      public String getAltText()
      Provides alternate information for the image element

      The altText property specifies an alternate text for an image. It is displayed by the browser if the image cannot be displayed. This is especially important for accessibility, because screen readers can't understand images, but rather will read aloud the alternative text assigned to them.

      Returns:
      alternative information about this image
      See Also:

    • setAltText

      public void setAltText(String altText)
      Sets the alternate text attribute of the image assosiated with this field
      Parameters:
      altText - the alternative information about the image

    • getHeight

      public String getHeight()
      Gets the height of the image
      Returns:
      height

    • setHeight

      public void setHeight(String height)
      Sets the height of the image
      Parameters:
      height -

    • getWidth

      public String getWidth()
      Gets the width of the image
      Specified by:
      getWidth in interface Component
      Overrides:
      getWidth in class ComponentBase
      Returns:
      width

    • setWidth

      public void setWidth(String width)
      Sets the width of the image
      Specified by:
      setWidth in interface Component
      Overrides:
      setWidth in class ComponentBase
      Parameters:
      width -

    • getCaptionHeaderText

      public String getCaptionHeaderText()
      Gets the caption header text
      Returns:
      captionHeaderText

    • setCaptionHeaderText

      public void setCaptionHeaderText(String captionHeaderText)
      Sets the caption header text
      Parameters:
      captionHeaderText -

    • getCaptionHeader

      public Header getCaptionHeader()
      Gets the caption header
      Returns:
      captionHeader

    • setCaptionHeader

      public void setCaptionHeader(Header captionHeader)
      Sets the caption header
      Parameters:
      captionHeader -

    • getCutlineText

      public String getCutlineText()
      Gets the cutline text
      Returns:
      cutlineText

    • setCutlineText

      public void setCutlineText(String cutlineText)
      Sets the cutline text
      Parameters:
      cutlineText -

    • getCutline

      public Message getCutline()
      Gets the cutline
      Returns:
      cutline

    • setCutline

      public void setCutline(Message cutline)
      Sets the cutline
      Parameters:
      cutline -

    • isCaptionHeaderAboveImage

      public boolean isCaptionHeaderAboveImage()
      Gets boolen of whether the caption header is above the image
      Returns:
      captionHeaderAboveImage

    • setCaptionHeaderAboveImage

      public void setCaptionHeaderAboveImage(boolean captionHeaderAboveImage)
      Sets boolen of whether the caption header is above the image
      Parameters:
      captionHeaderAboveImage -