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, DictionaryBean, UifDictionaryBean, Component, ScriptEventSupport, Field, 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:

Image, Serialized Form

Field Summary

Fields inherited from interface org.kuali.rice.krad.uif.component.Ordered

INITIAL_ORDER_VALUE

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

ImageField()

Method Summary

protected <T> void	copyProperties(T component) Copies the properties over for the copy method
String	getAltText() Provides alternate information for the image element
Header	getCaptionHeader() Gets the caption header
String	getCaptionHeaderText() Gets the caption header text
List<Component>	getComponentsForLifecycle() List of components that are contained within the component and should be sent through the lifecycle
Message	getCutline() Gets the cutline
String	getCutlineText() Gets the cutline text
String	getHeight() Gets the height of the image
Image	getImage() Retrieves the Image element wrapped by this field
String	getSource() Retrieves the URL the image wrapped by this field
String	getWidth() Gets the width of the image
boolean	isCaptionHeaderAboveImage() Gets boolen of whether the caption header is above the image
void	performFinalize(View view, Object model, Component parent) PerformFinalize override - calls super, corrects the field's Label for attribute to point to this field's content
void	setAltText(String altText) Sets the alternate text attribute of the image assosiated with this field
void	setCaptionHeader(Header captionHeader) Sets the caption header
void	setCaptionHeaderAboveImage(boolean captionHeaderAboveImage) Sets boolen of whether the caption header is above the image
void	setCaptionHeaderText(String captionHeaderText) Sets the caption header text
void	setCutline(Message cutline) Sets the cutline
void	setCutlineText(String cutlineText) Sets the cutline text
void	setHeight(String height) Sets the height of the image
void	setImage(Image image) Sets the Image to be wrapped by this field
void	setSource(String source) Sets the source URL for the Image associated with this field
void	setWidth(String width) Sets the width of the image

Methods inherited from class org.kuali.rice.krad.uif.field.FieldBase

getComponentSecurityClass, getComponentTypeName, getFieldLabel, getFieldSecurity, getLabel, getLabelColSpan, getLabelPlacement, getLabelStyleClasses, getShortLabel, isLabelRendered, performInitialization, setComponentSecurity, setFieldLabel, setLabel, setLabelColSpan, setLabelPlacement, setLabelRendered, setLabelStyleClasses, setNestedComponentIdAndSuffix, setShortLabel, setShowLabel

Methods inherited from class org.kuali.rice.krad.uif.component.ComponentBase

addCellCssClass, addDataAttribute, addDataAttributeIfNonEmpty, addStyleClass, appendToStyle, completeValidation, copy, getAdditionalComponentsToRefresh, getAdditionalComponentsToRefreshJs, getAdditionalCssClasses, getAlign, getBaseId, getCellCssClasses, getCellStyle, getCellStyleClassesAsString, getCellWidth, getColSpan, getComponentModifiers, getComponentPrototypes, getComponentSecurity, getConditionalRefresh, getConditionalRefreshConditionJs, getConditionalRefreshControlNames, getContext, getCssClasses, getDataAttributes, getEventHandlerScript, getFinalizeMethodAdditionalArguments, getFinalizeMethodInvoker, getFinalizeMethodToCall, getId, getLibraryCssClasses, getMethodToCallOnRefresh, getOnBlurScript, getOnChangeScript, getOnClickScript, getOnCloseScript, getOnDblClickScript, getOnDocumentReadyScript, getOnFocusScript, getOnKeyDownScript, getOnKeyPressScript, getOnKeyUpScript, getOnLoadScript, getOnMouseDownScript, getOnMouseMoveScript, getOnMouseOutScript, getOnMouseOverScript, getOnMouseUpScript, getOnSubmitScript, getOnUnloadScript, getOrder, getPostRenderContent, getPreRenderContent, getProgressiveDisclosureConditionJs, getProgressiveDisclosureControlNames, getProgressiveRender, getPropertyReplacerComponents, getPropertyReplacers, getRefreshTimer, getRefreshWhenChangedPropertyNames, getRenderedHtmlOutput, getRequired, getRowSpan, getSimpleDataAttributes, getStyle, getStyleClassesAsString, getTemplate, getTemplateName, getTemplateOptions, getTemplateOptionsJSString, getTitle, getToolTip, getValign, isDisableSessionPersistence, isDisclosedByAction, isForceSessionPersistence, isHidden, isProgressiveRenderAndRefresh, isProgressiveRenderViaAJAX, isReadOnly, isRefreshedByAction, isRender, isResetDataOnRefresh, isRetrieveViaAjax, isSelfRendered, isSkipInTabOrder, performApplyModel, pushAllToContext, pushObjectToContext, pushToPropertyReplacerContext, setAdditionalComponentsToRefresh, setAdditionalCssClasses, setAlign, setBaseId, setCellCssClasses, setCellStyle, setCellWidth, setColSpan, setComponentModifiers, setConditionalRefresh, setContext, setCssClasses, setDataAttributes, setDisableSessionPersistence, setDisclosedByAction, setFinalizeMethodAdditionalArguments, setFinalizeMethodInvoker, setFinalizeMethodToCall, setForceSessionPersistence, setHidden, setId, setLibraryCssClasses, setMethodToCallOnRefresh, setOnBlurScript, setOnChangeScript, setOnClickScript, setOnCloseScript, setOnDblClickScript, setOnDocumentReadyScript, setOnFocusScript, setOnKeyDownScript, setOnKeyPressScript, setOnKeyUpScript, setOnLoadScript, setOnMouseDownScript, setOnMouseMoveScript, setOnMouseOutScript, setOnMouseOverScript, setOnMouseUpScript, setOnSubmitScript, setOnUnloadScript, setOrder, setPostRenderContent, setPreRenderContent, setProgressiveRender, setProgressiveRenderAndRefresh, setProgressiveRenderViaAJAX, setPropertyReplacers, setReadOnly, setRefreshedByAction, setRefreshTimer, setRefreshWhenChangedPropertyNames, setRender, setRenderedHtmlOutput, setRequired, setResetDataOnRefresh, setRetrieveViaAjax, setRowSpan, setSelfRendered, setSkipInTabOrder, setStyle, setTemplate, setTemplateName, setTemplateOptions, setTemplateOptionsJSString, setTitle, setToolTip, setValign

Methods inherited from class org.kuali.rice.krad.datadictionary.uif.UifDictionaryBeanBase

getExpressionGraph, getPropertyExpression, getPropertyExpressions, getRefreshExpressionGraph, setExpressionGraph, setPropertyExpressions, setRefreshExpressionGraph

Methods inherited from class org.kuali.rice.krad.datadictionary.DictionaryBeanBase

getComponentCode, getNamespaceCode, setComponentCode, setNamespaceCode

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.krad.uif.component.Component

addCellCssClass, addDataAttribute, addStyleClass, appendToStyle, completeValidation, copy, getAdditionalComponentsToRefresh, getAdditionalComponentsToRefreshJs, getAdditionalCssClasses, getAlign, getBaseId, getCellCssClasses, getCellStyle, getCellWidth, getColSpan, getComponentModifiers, getComponentPrototypes, getComponentSecurity, getConditionalRefresh, getConditionalRefreshConditionJs, getConditionalRefreshControlNames, getContext, getCssClasses, getDataAttributes, getEventHandlerScript, getFinalizeMethodAdditionalArguments, getFinalizeMethodInvoker, getFinalizeMethodToCall, getId, getLibraryCssClasses, getOrder, getPostRenderContent, getPreRenderContent, getProgressiveDisclosureConditionJs, getProgressiveDisclosureControlNames, getProgressiveRender, getPropertyReplacerComponents, getPropertyReplacers, getRefreshTimer, getRefreshWhenChangedPropertyNames, getRenderedHtmlOutput, getRequired, getRowSpan, getSimpleDataAttributes, getStyle, getTemplate, getTemplateName, getTemplateOptions, getTemplateOptionsJSString, getTitle, getToolTip, getValign, isDisableSessionPersistence, isDisclosedByAction, isForceSessionPersistence, isHidden, isProgressiveRenderAndRefresh, isProgressiveRenderViaAJAX, isReadOnly, isRefreshedByAction, isRender, isResetDataOnRefresh, isRetrieveViaAjax, isSelfRendered, performApplyModel, pushAllToContext, pushObjectToContext, setAdditionalComponentsToRefresh, setAdditionalCssClasses, setAlign, setBaseId, setCellCssClasses, setCellStyle, setCellWidth, setColSpan, setComponentModifiers, setConditionalRefresh, setContext, setCssClasses, setDataAttributes, setDisableSessionPersistence, setDisclosedByAction, setForceSessionPersistence, setHidden, setId, setLibraryCssClasses, setOrder, setPostRenderContent, setPreRenderContent, setProgressiveRender, setProgressiveRenderAndRefresh, setProgressiveRenderViaAJAX, setPropertyReplacers, setReadOnly, setRefreshedByAction, setRefreshTimer, setRefreshWhenChangedPropertyNames, setRender, setRenderedHtmlOutput, setRequired, setResetDataOnRefresh, setRetrieveViaAjax, setRowSpan, setSelfRendered, setStyle, setTemplate, setTemplateName, setTemplateOptions, setTemplateOptionsJSString, setTitle, setToolTip, setValign

Methods inherited from interface org.kuali.rice.krad.datadictionary.uif.UifDictionaryBean

getExpressionGraph, getPropertyExpression, getPropertyExpressions, getRefreshExpressionGraph, setExpressionGraph, setPropertyExpressions, setRefreshExpressionGraph

Methods inherited from interface org.kuali.rice.krad.datadictionary.DictionaryBean

getComponentCode, getNamespaceCode

Methods inherited from interface org.kuali.rice.krad.uif.component.ScriptEventSupport

getOnBlurScript, getOnChangeScript, getOnClickScript, getOnCloseScript, getOnDblClickScript, getOnDocumentReadyScript, getOnFocusScript, getOnKeyDownScript, getOnKeyPressScript, getOnKeyUpScript, getOnLoadScript, getOnMouseDownScript, getOnMouseMoveScript, getOnMouseOutScript, getOnMouseOverScript, getOnMouseUpScript, getOnSubmitScript, getOnUnloadScript, setOnBlurScript, setOnChangeScript, setOnClickScript, setOnCloseScript, setOnDblClickScript, setOnDocumentReadyScript, setOnFocusScript, setOnKeyDownScript, setOnKeyPressScript, setOnKeyUpScript, setOnLoadScript, setOnMouseDownScript, setOnMouseMoveScript, setOnMouseOutScript, setOnMouseOverScript, setOnMouseUpScript, setOnSubmitScript, setOnUnloadScript

Constructor Detail

ImageField

public ImageField()

Method Detail

performFinalize

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

PerformFinalize override - calls super, corrects the field's Label for attribute to point to this field's content

Specified by:

performFinalize in interface Component

Overrides:

performFinalize in class FieldBase

Parameters:

view - the view

model - the model

parent - the parent component

See Also:

ComponentBase.performFinalize(org.kuali.rice.krad.uif.view.View, java.lang.Object, org.kuali.rice.krad.uif.component.Component)

getComponentsForLifecycle

public List<Component> getComponentsForLifecycle()

Description copied from interface: Component

List of components that are contained within the component and should be sent through the lifecycle

Used by ViewHelperService for the various lifecycle callbacks

Specified by:

getComponentsForLifecycle in interface Component

Overrides:

getComponentsForLifecycle in class FieldBase

Returns:

List child components

See Also:

ComponentBase.getComponentsForLifecycle()

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:

Image.getSource()

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:

Image.getAltText()

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 -

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 -

See Also:

Component.setWidth(java.lang.String)

getWidth

public String getWidth()

Gets the width of the image

Specified by:

getWidth in interface Component

Overrides:

getWidth in class ComponentBase

Returns:

width

See Also:

Component.getWidth()

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 -

copyProperties

protected <T> void copyProperties(T component)

Description copied from class: ComponentBase

Copies the properties over for the copy method

Overrides:

copyProperties in class FieldBase

Parameters:

component - base bean

See Also:

ComponentBase.copy()