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

Class Link

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

  • Constructor Details

    • Link

      public Link()

  • Method Details

    • performApplyModel

      public void performApplyModel(Object model, LifecycleElement parent)
      The following updates are done here:
      • Initialize the nested lightBox widget if open in lightbox is true
      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

    • performFinalize

      public void performFinalize(Object model, LifecycleElement parent)
      Special handling for lightbox links to add and onclick data attribute to be handled by a global handler
      Specified by:
      performFinalize in interface LifecycleElement
      Overrides:
      performFinalize in class ComponentBase
      Parameters:
      model - - top level object containing the data
      parent - - parent component

    • getLinkText

      public String getLinkText()
      Returns the label of the link
      Returns:
      The link label

    • setLinkText

      public void setLinkText(String linkText)
      Setter for the link label
      Parameters:
      linkText -

    • getTarget

      public String getTarget()
      Returns the target that will be used to specify where to open the href
      Returns:
      The target

    • setTarget

      public void setTarget(String target)
      Setter for the link target
      Parameters:
      target -

    • getHref

      public String getHref()
      Returns the href text
      Returns:
      The href text

    • setHref

      public void setHref(String href)
      Setter for the hrefText
      Parameters:
      href -

    • getLinkDialogId

      public String getLinkDialogId()
      The id of the DialogGroup to use when the openInDialog property is true.

      The DialogGroup should only contain an iframe for its items. When not set, a default dialog will be used.

      Returns:
      the id of the dialog to use for this link

    • setLinkDialogId

      public void setLinkDialogId(String linkDialogId)
      See Also:

    • isOpenInDialog

      public boolean isOpenInDialog()
      Indicates whether the link URL should be opened in a dialog.

      If set the target attribute is ignored and the URL is opened in a dialog instead.

      Returns:
      true to open link in a dialog, false if not (follow standard target attribute)

    • setOpenInDialog

      public void setOpenInDialog(boolean openInDialog)
      See Also:

    • getIconClass

      public String getIconClass()
      Icon Class for the link

      Bootstrap Icon Class to be rendered on this Link

      Returns:
      label for action

    • setIconClass

      public void setIconClass(String iconClass)
      Setter for the Icon Class
      Parameters:
      iconClass -

    • getLinkIconPlacement

      public String getLinkIconPlacement()
      Set to LEFT, RIGHT to position image at that location within the button. When set to blank/null/ICON_ONLY, the icon itself will be the Action, if no value is set the default is ALWAYS LEFT, you must explicitly set blank/null/ICON_ONLY to use ONLY the image as the Action.
      Returns:
      Action Icon Placement

    • setLinkIconPlacement

      public void setLinkIconPlacement(String linkIconPlacement)
      Setter for the Link Icon Placement
      Parameters:
      linkIconPlacement -

    • 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