Package org.kuali.rice.krad.uif.element

Class Image

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.element.ContentElementBase
org.kuali.rice.krad.uif.element.Image
All Implemented Interfaces:
Serializable, Cloneable, Copyable, DictionaryBean, UifDictionaryBean, Component, Ordered, ScriptEventSupport, ContentElement, LifecycleElement, org.springframework.core.Ordered
public class Image extends ContentElementBase
Content element that renders a HTML <IMG> tag
Author:
Kuali Rice Team (rice.collab@kuali.org)
See Also:

  • Constructor Details

    • Image

      public Image()

  • Method Details

    • performInitialization

      public void performInitialization(Object model)
      The following initialization is performed:
      • Initializes the cutline message and caption header components if necessary
      The following updates are done here:
      • Invoke performInitialize on component modifiers
      Initializes the component

      Where components can set defaults and setup other necessary state. The initialize method should only be called once per component lifecycle and is invoked within the initialize phase of the view lifecylce.

      Specified by:
      performInitialization in interface LifecycleElement
      Overrides:
      performInitialization in class ComponentBase
      Parameters:
      model - - object instance containing the view data
      See Also:

    • performApplyModel

      public void performApplyModel(Object model, LifecycleElement parent)
      Performs the following steps
      • Set the caption header text on the caption header
      • Set the cutline text on the cutline message
      The following updates are done here:
      • Evaluate the progressive render condition (if set) and combine with the current render status to set the render status
      Called after the initialize phase to perform conditional logic based on the model data

      Where components can perform conditional logic such as dynamically generating new fields or setting field state based on the given data

      Specified by:
      performApplyModel in interface LifecycleElement
      Overrides:
      performApplyModel in class ComponentBase
      Parameters:
      model - - Top level object containing the data (could be the form or a top level business object, dto)
      parent - parent lifecycle element

    • getSource

      public String getSource()
      returns the URL of this image
      Returns:
      the URL of this image.

    • setSource

      public void setSource(String source)
      Sets the URL of this image
      Parameters:
      source - the URL of this 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.


      Some best practices:
      • spacer images, bullets, and icons should have the altText set to null or the empty string. This will prevent screen readers from announcing it.
      • Make the altText message as short and succinct as possible
      • Describe the content of the image and nothing more
      Returns:
      alternative information about this image

    • setAltText

      public void setAltText(String altText)
      Sets the alternate text property for this image
      Parameters:
      altText - the alternative information about the image

    • getHeight

      public String getHeight()
      Returns the height style attribute of this image

      The default unit of measure is pixels.
      It is good practice to specify both the height and width attributes for an image. If these attributes are set, the space required for the image is reserved when the page is loaded. However, without these attributes, the browser does not know the size of the image. The effect will be that the page layout will change while the images load.

      Returns:
      the height style attribute of this image

    • setHeight

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

    • getWidth

      public String getWidth()
      Returns the width style attribute of the image

      The default unit of measure is pixels.
      It is good practice to specify both the height and width attributes for an image. If these attributes are set, the space required for the image is reserved when the page is loaded. However, without these attributes, the browser does not know the size of the image. The effect will be that the page layout will change while the images load.

      Specified by:
      getWidth in interface Component
      Overrides:
      getWidth in class ComponentBase
      Returns:
      the width of this image

    • setWidth

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

    • getCaptionHeaderText

      public String getCaptionHeaderText()
      Retrieves the caption text for this image

      The caption text is a headline for the picture. It may be displayed either above or below the picture.

      Returns:
      the caption

    • setCaptionHeaderText

      public void setCaptionHeaderText(String captionHeaderText)
      Sets the text displayed as of the caption for the picture
      Parameters:
      captionHeaderText - the caption text

    • getCaptionHeader

      public Header getCaptionHeader()
      Retrieves the Header component used to display the caption for this image
      Returns:
      Header component which wraps the caption text.

    • setCaptionHeader

      public void setCaptionHeader(Header captionHeader)
      Sets the Header used to display the caption for this image
      Parameters:
      captionHeader - header component which wraps the caption text

    • getCutlineText

      public String getCutlineText()
      Retrieves the cutline text for this image

      The cutline text give more detailed information about the picture. Generally it describes the who, what, where, when of this image.

      Returns:
      the cutline text.

    • setCutlineText

      public void setCutlineText(String cutlineText)
      Sets the cutline text that describes this image
      Parameters:
      cutlineText - the cutline text that describes this image

    • getCutlineMessage

      public Message getCutlineMessage()
      Gets the Message component used to display the cutline.

      Wrapping the cutline text with a Message component allows styling of the cutline text.

      Returns:
      Message component wrapping the cutline

    • setCutlineMessage

      public void setCutlineMessage(Message cutlineMessage)
      Sets the Message component used to display the cutline for this image
      Parameters:
      cutlineMessage - Message

    • isCaptionHeaderPlacementAboveImage

      public boolean isCaptionHeaderPlacementAboveImage()
      Specifies whether the image caption is to be displayed above or below the image
      Returns:
      true if the caption is to be displayed above the image. false if displayed below the image.

    • setCaptionHeaderPlacementAboveImage

      public void setCaptionHeaderPlacementAboveImage(boolean captionHeaderPlacementAboveImage)
      Sets whether the image caption is to be displayed above or below the image
      Parameters:
      captionHeaderPlacementAboveImage - true displays above image, false displays below image

    • completeValidation

      public void completeValidation(ValidationTrace tracer)
      Validates different requirements of component compiling a series of reports detailing information on errors found in the component. Used by the RiceDictionaryValidator.
      Specified by:
      completeValidation in interface Component
      Overrides:
      completeValidation in class ComponentBase
      Parameters:
      tracer - Record of component's location