|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.container.ContainerBase org.kuali.rice.krad.uif.container.Group org.kuali.rice.krad.uif.container.DialogGroup
public class DialogGroup
Special type of Group
that presents a the content for a modal dialog
This type of group will be hidden when the main view is displayed. It will be used as content inside the LightBox widget when the modal dialog is displayed. For convenience, this group contains a standard set of components for commonly used modal dialogs
InputField
for holding the user's textual response
The DialogGroup may also serve as a base class for more complex dialogs.
The default settings for this DialogGroup is to display a prompt message
with two buttons labeled OK and Cancel.
The optional explanation TextAreaControl
is hidden by default.
The prompt text, number of user options and their corresponding label are configurable.
The InputField
for the explanation is TextAreaControl
by default.
It may be configured to other types of InputFields.
The Component for ResponseInputField is a HorizontalCheckboxGroup
by default.
JQuery styling is then used to style the checkboxes as buttons. The ResponseInputField may
be configured to other InputField
types.
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 | |
---|---|
DialogGroup()
|
Method Summary | |
---|---|
List<KeyValue> |
getAvailableResponses()
Gets the choices provided for user response. |
List<Component> |
getComponentsForLifecycle()
List of components that are contained within the component and should be sent through the lifecycle |
InputField |
getExplanation()
Retrieves the explanation InputField used to gather user input text from the dialog |
MessageField |
getPrompt()
Retrieves the Message element for this dialog |
String |
getPromptText()
Returns the text to be displayed as the prompt or main message in this simple dialog |
InputField |
getResponseInputField()
Retrieves the InputField containing the choices displayed in this dialog |
boolean |
isDisplayExplanation()
determines if the explanation InputField is to be displayed in this dialog |
boolean |
isReverseButtonOrder()
Determines the positioning order of the choices displayed on this dialog |
boolean |
isUseAjaxCallForContent()
indicates which approach is used to fill the lightbox content for this dialog. |
void |
performFinalize(View view,
Object model,
Component parent)
Performs the final phase of the component lifecycle. |
void |
performInitialization(View view,
Object model)
The following actions are performed: Move custom dialogGroup properties prompt, explanation, and responseInputField into items collection |
void |
setAvailableResponses(List<KeyValue> availableResponses)
Sets the list of user responses to provide on this dialog |
void |
setDisplayExplanation(boolean displayExplanation)
Sets whether to display the Explanation InputField on this dialog |
void |
setExplanation(InputField explanation)
Sets the InputField for gathering user text input |
void |
setPrompt(MessageField prompt)
Sets the prompt Message for this dialog |
void |
setPromptText(String promptText)
Sets the text String to display as the main message in this dialog |
void |
setResponseInputField(InputField responseInputField)
Sets the type of InputField used to display the user choices in this dialog |
void |
setReverseButtonOrder(boolean reverseButtonOrder)
Sets the display order of the choices displayed on this dialog |
void |
setUseAjaxCallForContent(boolean useAjaxCallForContent)
Sets whether the content for the dialog will be filled via ajax call or hidden group |
Methods inherited from class org.kuali.rice.krad.uif.container.Group |
---|
completeValidation, getComponentTypeName, getDisclosure, getFieldBindByNamePrefix, getFieldBindingObjectPath, getItems, getScrollpane, getSupportedComponents, setDisclosure, setFieldBindByNamePrefix, setFieldBindingObjectPath, setItems, setScrollpane |
Methods inherited from class org.kuali.rice.krad.uif.container.ContainerBase |
---|
getComponentPrototypes, getDefaultItemPosition, getFooter, getHeader, getHeaderText, getHelp, getHelpTitle, getInstructionalMessage, getInstructionalText, getLayoutManager, getValidationMessages, performApplyModel, setDefaultItemPosition, setFooter, setHeader, setHeaderText, setHelp, setInstructionalMessage, setInstructionalText, setLayoutManager, setRenderFooter, setRenderHeader, setTooltipOfComponent, setValidationMessages |
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.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, setOnLoadScript |
Constructor Detail |
---|
public DialogGroup()
Method Detail |
---|
public List<Component> getComponentsForLifecycle()
Component
Used by ViewHelperService
for the various lifecycle callbacks
getComponentsForLifecycle
in interface Component
getComponentsForLifecycle
in class Group
ComponentBase.getComponentsForLifecycle()
public void performInitialization(View view, Object model)
performInitialization
in interface Component
performInitialization
in class Group
view
- - view instance in which the component belongsmodel
- - object instance containing the view dataComponentBase.performInitialization(org.kuali.rice.krad.uif.view.View,
java.lang.Object)
public void performFinalize(View view, Object model, Component parent)
For this DialogGroup component, perform the following:
performFinalize
in interface Component
performFinalize
in class ContainerBase
view
- - view instance that should be finalized for renderingmodel
- - top level object containing the dataparent
- - parent componentComponentBase.performFinalize(org.kuali.rice.krad.uif.view.View,
java.lang.Object, org.kuali.rice.krad.uif.component.Component)
public String getPromptText()
public void setPromptText(String promptText)
promptText
- - the String to be displayed as the main messagepublic MessageField getPrompt()
public void setPrompt(MessageField prompt)
prompt
- - The Message element for this dialogpublic InputField getExplanation()
By default, the control for this input is configured as a TextAreaControl. It may be configured for other types of input fields.
public void setExplanation(InputField explanation)
explanation
- - InputFieldpublic boolean isDisplayExplanation()
False by default.
public void setDisplayExplanation(boolean displayExplanation)
displayExplanation
- - true if explanation control is to be displayed, false if notpublic List<KeyValue> getAvailableResponses()
A List of KeyValue pairs for each of the choices provided on this dialog.
public void setAvailableResponses(List<KeyValue> availableResponses)
availableResponses
- - a List of KeyValue pairs representing the user response choicespublic InputField getResponseInputField()
By default, this InputField is configured to be a HorizontalCheckboxControl. Styling is then used to make the checkboxes appear to be buttons. The values of the availableResponses List are used as labels for the "buttons".
public void setResponseInputField(InputField responseInputField)
responseInputField
- - A component used to display the response choicespublic boolean isReverseButtonOrder()
Some page designers like the positive choice on the left and the negative choice on the right. Others, prefer just the opposite. This allows the order to easily be switched.
public void setReverseButtonOrder(boolean reverseButtonOrder)
By default, the choices are displayed left to right
reverseButtonOrder
- - true if buttons displayed left to right, false if right to leftpublic boolean isUseAjaxCallForContent()
Two techniques are used for filling the content of the lightbox when displaying this dialog.
public void setUseAjaxCallForContent(boolean useAjaxCallForContent)
useAjaxCallForContent
- - boolean set to true if ajax call is used to get content,
false if hidden group is used for content.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |