org.kuali.rice.krad.uif.widget
Class LightBox

java.lang.Object
  org.kuali.rice.krad.uif.component.ConfigurableBase
      org.kuali.rice.krad.uif.component.ComponentBase
          org.kuali.rice.krad.uif.widget.WidgetBase
              org.kuali.rice.krad.uif.widget.LightBox

All Implemented Interfaces:

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

public class LightBox
extends WidgetBase

Used for rendering a lightbox in the UI to display action links in dialog popups

Author:

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

See Also:

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

LightBox()

Method Summary

String	getActionParameterMapString() Action parameter map javascript string
String	getComponentOptionsJSString() Builds a string from the underlying Map of component options that will export that options as a JavaScript Map for use in js and jQuery plugins
String	getHeight()
String	getWidth() Width the component should take up in the container
boolean	isLookupReturnByScript()
void	setActionParameterMapString(String actionParameterMapString) Setter for the action parameter map javascript string
void	setHeight(String height) Setter for the height of the light box Can be percentage.
void	setLookupReturnByScript(boolean lookupReturnByScript) Setter for the flag to indicate that lookups will return the value by script and not a post
void	setWidth(String width) Setter for the width of the light box Can be percentage.

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

getComponentTypeName

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

addStyleClass, appendToStyle, getAlign, getColSpan, getComponentModifiers, getComponentOptions, getComponentPrototypes, getComponentsForLifecycle, getConditionalRefresh, getConditionalRefreshConditionJs, getConditionalRefreshControlNames, getContext, getEventCode, getFactoryId, getFinalizeMethodAdditionalArguments, getFinalizeMethodInvoker, getFinalizeMethodToCall, getId, getOnBlurScript, getOnChangeScript, getOnClickScript, getOnCloseScript, getOnDblClickScript, getOnDocumentReadyScript, getOnFocusScript, getOnKeyDownScript, getOnKeyPressScript, getOnKeyUpScript, getOnLoadScript, getOnMouseDownScript, getOnMouseMoveScript, getOnMouseOutScript, getOnMouseOverScript, getOnMouseUpScript, getOnSubmitScript, getOnUnloadScript, getOrder, getProgressiveDisclosureConditionJs, getProgressiveDisclosureControlNames, getProgressiveRender, getPropertyReplacerComponents, getPropertyReplacers, getRefreshDiscloseMethodToCall, getRefreshWhenChanged, getRefreshWhenChangedControlNames, getRenderOutput, 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, isHidden, isProgressiveRenderAndRefresh, isProgressiveRenderViaAJAX, isReadOnly, isRefresh, isRefreshedByAction, isRender, isResetDataOnRefresh, isSelfRendered, isSkipInTabOrder, performApplyModel, performFinalize, performInitialization, pushAllToContext, pushObjectToContext, pushToPropertyReplacerContext, setAlign, setColSpan, setComponentModifiers, setComponentOptions, setComponentOptionsJSString, setConditionalRefresh, setContext, setFactoryId, setFinalizeMethodAdditionalArguments, setFinalizeMethodInvoker, setFinalizeMethodToCall, setHidden, setId, setOnBlurScript, setOnChangeScript, setOnClickScript, setOnCloseScript, setOnDblClickScript, setOnDocumentReadyScript, setOnFocusScript, setOnKeyDownScript, setOnKeyPressScript, setOnKeyUpScript, setOnLoadScript, setOnMouseDownScript, setOnMouseMoveScript, setOnMouseOutScript, setOnMouseOverScript, setOnMouseUpScript, setOnSubmitScript, setOnUnloadScript, setOrder, setProgressiveRender, setProgressiveRenderAndRefresh, setProgressiveRenderViaAJAX, setPropertyReplacers, setReadOnly, setRefresh, setRefreshDiscloseMethodToCall, setRefreshedByAction, setRefreshWhenChanged, setRender, setRenderOutput, setRequired, setResetDataOnRefresh, setRowSpan, setSelfRendered, setSkipInTabOrder, setStyle, setStyleClasses, setTemplate, setTitle, setValign

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

getPropertyExpression, getPropertyExpressions, setPropertyExpressions

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

addStyleClass, appendToStyle, getColSpan, getComponentModifiers, getComponentOptions, getComponentPrototypes, getComponentsForLifecycle, getConditionalRefresh, getConditionalRefreshConditionJs, getConditionalRefreshControlNames, getContext, getFactoryId, getFinalizeMethodAdditionalArguments, getFinalizeMethodInvoker, getFinalizeMethodToCall, getId, getOrder, getProgressiveDisclosureConditionJs, getProgressiveDisclosureControlNames, getProgressiveRender, getPropertyReplacerComponents, getPropertyReplacers, getRefreshWhenChanged, getRefreshWhenChangedControlNames, getRenderOutput, getRequired, getRowSpan, getStyle, getStyleClasses, getTemplate, getTitle, isHidden, isProgressiveRenderAndRefresh, isProgressiveRenderViaAJAX, isReadOnly, isRefresh, isRefreshedByAction, isRender, isResetDataOnRefresh, isSelfRendered, performApplyModel, performFinalize, performInitialization, pushAllToContext, pushObjectToContext, setColSpan, setComponentModifiers, setComponentOptions, setComponentOptionsJSString, setConditionalRefresh, setContext, setFactoryId, setHidden, setId, setOrder, setProgressiveRender, setProgressiveRenderAndRefresh, setProgressiveRenderViaAJAX, setPropertyReplacers, setReadOnly, setRefresh, setRefreshedByAction, setRefreshWhenChanged, setRender, setRenderOutput, setRequired, setResetDataOnRefresh, setRowSpan, setSelfRendered, setStyle, setStyleClasses, setTemplate, setTitle

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

getPropertyExpression, getPropertyExpressions, setPropertyExpressions

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, getSupportsOnBlur, getSupportsOnChange, getSupportsOnClick, getSupportsOnClose, getSupportsOnDblClick, getSupportsOnDocumentReady, getSupportsOnFocus, getSupportsOnKeyDown, getSupportsOnKeyPress, getSupportsOnKeyUp, getSupportsOnLoad, getSupportsOnMouseDown, getSupportsOnMouseMove, getSupportsOnMouseOut, getSupportsOnMouseOver, getSupportsOnMouseUp, getSupportsOnSubmit, getSupportsOnUnload, setOnBlurScript, setOnLoadScript

Constructor Detail

LightBox

public LightBox()

Method Detail

setActionParameterMapString

public void setActionParameterMapString(String actionParameterMapString)

Setter for the action parameter map javascript string

Parameters:

actionParameterMapString - the action parameter map javascript string

getActionParameterMapString

public String getActionParameterMapString()

Action parameter map javascript string

The action parameter map string will be used to write these parameters to the form.

Returns:

the action parameter map javascript string

getHeight

public String getHeight()

Returns:

height of light box

setHeight

public void setHeight(String height)

Setter for the height of the light box Can be percentage. ie. 75%

Parameters:

height -

getWidth

public String getWidth()

Description copied from class: ComponentBase

Width the component should take up in the container

All components belong to a Container and are placed using a LayoutManager. This property specifies a width the component should take up in the Container. This is not applicable for all layout managers. During the finalize phase the CSS width style will be created for the width setting.

e.g. '30%', '55px'

Overrides:

getWidth in class ComponentBase

Returns:

width of light box

setWidth

public void setWidth(String width)

Setter for the width of the light box Can be percentage. ie. 75%

Overrides:

setWidth in class ComponentBase

Parameters:

width -

getComponentOptionsJSString

public String getComponentOptionsJSString()

Description copied from class: ComponentBase

Builds a string from the underlying Map of component options that will export that options as a JavaScript Map for use in js and jQuery plugins

Specified by:

getComponentOptionsJSString in interface Component

Overrides:

getComponentOptionsJSString in class ComponentBase

Returns:

String of widget options formatted as JS Map

See Also:

ComponentBase.getComponentOptionsJSString()

isLookupReturnByScript

public boolean isLookupReturnByScript()

Returns:

the lookupReturnByScript flag

setLookupReturnByScript

public void setLookupReturnByScript(boolean lookupReturnByScript)

Setter for the flag to indicate that lookups will return the value by script and not a post

Parameters:

lookupReturnByScript - the lookupReturnByScript flag