org.kuali.rice.kns.uif.widget
Class Inquiry

java.lang.Object
  org.kuali.rice.kns.uif.core.ComponentBase
      org.kuali.rice.kns.uif.widget.WidgetBase
          org.kuali.rice.kns.uif.widget.Inquiry

All Implemented Interfaces:

Serializable, Component, ScriptEventSupport, Widget, org.springframework.core.Ordered

public class Inquiry
extends WidgetBase

Widget for rendering an Inquiry link on a field's value

Author:

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

See Also:

Serialized Form

Field Summary

static String

INQUIRY_TITLE_PREFIX

Fields inherited from interface org.kuali.rice.kns.uif.core.Ordered

INITIAL_ORDER_VALUE

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Inquiry()

Method Summary

void	buildInquiryLink(Object dataObject, String propertyName, Class<?> inquiryObjectClass, Map<String,String> inquiryParms) Builds the inquiry link based on the given inquiry class and parameters
String	createTitleText(Class<?> dataObjectClass) Gets text to prepend to the inquiry link title
String	getBaseInquiryUrl()
String	getBindingPrefix()
String	getConditionalReadOnly() Expression language string for conditionally setting the readOnly property
String	getDataObjectClassName()
ActionField	getDirectInquiryActionField()
LinkField	getInquiryLinkField()
Map<String,String>	getInquiryParameters()
List<Component>	getNestedComponents() List of components that are contained within the component
String	getViewName()
boolean	isBindToMap()
boolean	isForceInquiry()
boolean	isReadOnly() Indicates whether the component can be edited
void	performFinalize(View view, Object model, Component parent) The following finalization is done here: If any of the style properties were given, sets the style string on the style property Setup the decorator chain (if component has decorators) for rendering
void	setBaseInquiryUrl(String baseInquiryUrl)
void	setBindingPrefix(String bindingPrefix)
void	setBindToMap(boolean bindToMap)
void	setConditionalReadOnly(String conditionalReadOnly) Setter for the conditional readOnly string
void	setDataObjectClassName(String dataObjectClassName)
void	setDirectInquiryActionField(ActionField directInquiryActionField)
void	setForceInquiry(boolean forceInquiry)
void	setInquiryLinkField(LinkField inquiryLinkField)
void	setInquiryParameters(Map<String,String> inquiryParameters)
void	setInquiryParameters(String inquiryParameterString)
void	setReadOnly(boolean readOnly) Setter for the read only indicator
void	setViewName(String viewName)

Methods inherited from class org.kuali.rice.kns.uif.widget.WidgetBase

getComponentTypeName

Methods inherited from class org.kuali.rice.kns.uif.core.ComponentBase

addStyleClass, appendToStyle, getAlign, getColSpan, getComponentModifiers, getComponentOptions, getComponentOptionsJSString, getConditionalColSpan, getConditionalRender, getConditionalRequired, getConditionalRowSpan, getContext, getEventCode, getId, getOnBlurScript, getOnChangeScript, getOnClickScript, getOnCloseScript, getOnDblClickScript, getOnDocumentReadyScript, getOnFocusScript, getOnKeyDownScript, getOnKeyPressScript, getOnKeyUpScript, getOnLoadScript, getOnMouseDownScript, getOnMouseMoveScript, getOnMouseOutScript, getOnMouseOverScript, getOnMouseUpScript, getOnSubmitScript, getOnUnloadScript, getOrder, getPropertiesForReferenceCopy, getPropertyReplacers, getRequired, getRowSpan, getStyle, getStyleClasses, getStyleClassesAsString, getSupportsOnBlur, getSupportsOnChange, getSupportsOnClick, getSupportsOnClose, getSupportsOnDblClick, getSupportsOnDocumentReady, getSupportsOnFocus, getSupportsOnKeyDown, getSupportsOnKeyPress, getSupportsOnKeyUp, getSupportsOnLoad, getSupportsOnMouseDown, getSupportsOnMouseMove, getSupportsOnMouseOut, getSupportsOnMouseOver, getSupportsOnMouseUp, getSupportsOnSubmit, getSupportsOnUnload, getTemplate, getTitle, getValign, getWidth, isHidden, isRender, performApplyModel, performInitialization, pushObjectToContext, setAlign, setColSpan, setComponentModifiers, setComponentOptions, setConditionalColSpan, setConditionalRender, setConditionalRequired, setConditionalRowSpan, setContext, setHidden, setId, setOnBlurScript, setOnChangeScript, setOnClickScript, setOnCloseScript, setOnDblClickScript, setOnDocumentReadyScript, setOnFocusScript, setOnKeyDownScript, setOnKeyPressScript, setOnKeyUpScript, setOnLoadScript, setOnMouseDownScript, setOnMouseMoveScript, setOnMouseOutScript, setOnMouseOverScript, setOnMouseUpScript, setOnSubmitScript, setOnUnloadScript, setOrder, setPropertyReplacers, setRender, setRequired, setRowSpan, setStyle, setStyleClasses, setStyleClasses, setTemplate, setTitle, setValign, setWidth

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.kuali.rice.kns.uif.core.Component

addStyleClass, appendToStyle, getColSpan, getComponentModifiers, getComponentOptions, getContext, getId, getOrder, getPropertiesForReferenceCopy, getPropertyReplacers, getRequired, getRowSpan, getStyle, getStyleClasses, getTemplate, getTitle, isHidden, isRender, performApplyModel, performInitialization, pushObjectToContext, setColSpan, setComponentModifiers, setComponentOptions, setContext, setHidden, setId, setOrder, setPropertyReplacers, setRender, setRequired, setRowSpan, setStyle, setStyleClasses, setTemplate, setTitle

Field Detail

INQUIRY_TITLE_PREFIX

public static final String INQUIRY_TITLE_PREFIX

See Also:

Constant Field Values

Constructor Detail

Inquiry

public Inquiry()

Method Detail

performFinalize

public void performFinalize(View view,
                            Object model,
                            Component parent)

Description copied from class: ComponentBase

The following finalization is done here:

• If any of the style properties were given, sets the style string on the style property
• Setup the decorator chain (if component has decorators) for rendering

Specified by:

performFinalize in interface Component

Overrides:

performFinalize in class ComponentBase

Parameters:

view - - view instance that should be finalized for rendering

model - - top level object containing the data

parent - - parent component

See Also:

ComponentBase.performFinalize(org.kuali.rice.kns.uif.container.View, java.lang.Object, org.kuali.rice.kns.uif.core.Component)

buildInquiryLink

public void buildInquiryLink(Object dataObject,
                             String propertyName,
                             Class<?> inquiryObjectClass,
                             Map<String,String> inquiryParms)

Builds the inquiry link based on the given inquiry class and parameters

Parameters:

dataObject - - parent object that contains the data (used to pull inquiry parameters)

propertyName - - name of the property the inquiry is set on

inquiryObjectClass - - class of the object the inquiry should point to

inquiryParms - - map of key field mappings for the inquiry

createTitleText

public String createTitleText(Class<?> dataObjectClass)

Gets text to prepend to the inquiry link title

Parameters:

dataObjectClass - - data object class being inquired into

Returns:

String title prepend text

getNestedComponents

public List<Component> getNestedComponents()

Description copied from interface: Component

List of components that are contained within the component

Used by ViewHelperService for the various lifecycle callbacks

Specified by:

getNestedComponents in interface Component

Overrides:

getNestedComponents in class ComponentBase

Returns:

List child components

See Also:

ComponentBase.getNestedComponents()

getBaseInquiryUrl

public String getBaseInquiryUrl()

setBaseInquiryUrl

public void setBaseInquiryUrl(String baseInquiryUrl)

getDataObjectClassName

public String getDataObjectClassName()

setDataObjectClassName

public void setDataObjectClassName(String dataObjectClassName)

getViewName

public String getViewName()

setViewName

public void setViewName(String viewName)

isForceInquiry

public boolean isForceInquiry()

setForceInquiry

public void setForceInquiry(boolean forceInquiry)

getInquiryParameters

public Map<String,String> getInquiryParameters()

setInquiryParameters

public void setInquiryParameters(Map<String,String> inquiryParameters)

setInquiryParameters

public void setInquiryParameters(String inquiryParameterString)

getInquiryLinkField

public LinkField getInquiryLinkField()

setInquiryLinkField

public void setInquiryLinkField(LinkField inquiryLinkField)

getDirectInquiryActionField

public ActionField getDirectInquiryActionField()

Returns:

the directInquiryActionField

setDirectInquiryActionField

public void setDirectInquiryActionField(ActionField directInquiryActionField)

Parameters:

directInquiryActionField - the directInquiryActionField to set

getConditionalReadOnly

public String getConditionalReadOnly()

Description copied from interface: Component

Expression language string for conditionally setting the readOnly property

Specified by:

getConditionalReadOnly in interface Component

Overrides:

getConditionalReadOnly in class ComponentBase

Returns:

the conditionalReadOnly

See Also:

Component.getConditionalReadOnly()

setConditionalReadOnly

public void setConditionalReadOnly(String conditionalReadOnly)

Description copied from interface: Component

Setter for the conditional readOnly string

Specified by:

setConditionalReadOnly in interface Component

Overrides:

setConditionalReadOnly in class ComponentBase

Parameters:

conditionalReadOnly - the conditionalReadOnly to set

See Also:

Component.setConditionalReadOnly(java.lang.String)

isReadOnly

public boolean isReadOnly()

Description copied from interface: Component

Indicates whether the component can be edited

When readOnly the controls and widgets of Field components will not be rendered. If the Field has an underlying value it will be displayed readOnly to the user.

For a Container component, the readOnly setting will apply to all contained components (making a section readOnly makes all fields within the section readOnly)

Specified by:

isReadOnly in interface Component

Overrides:

isReadOnly in class ComponentBase

Returns:

the readOnly

See Also:

Component.isReadOnly()

setReadOnly

public void setReadOnly(boolean readOnly)

Description copied from interface: Component

Setter for the read only indicator

Specified by:

setReadOnly in interface Component

Overrides:

setReadOnly in class ComponentBase

Parameters:

readOnly - the readOnly to set

See Also:

Component.setReadOnly(boolean)

getBindingPrefix

public String getBindingPrefix()

Returns:

the bindingPrefix

setBindingPrefix

public void setBindingPrefix(String bindingPrefix)

Parameters:

bindingPrefix - the bindingPrefix to set

setBindToMap

public void setBindToMap(boolean bindToMap)

Parameters:

bindToMap - the bindToMap to set

isBindToMap

public boolean isBindToMap()

Returns:

the bindToMap