edu.internet2.middleware.grouper.grouperUi.beans.json
Class GuiScreenAction

java.lang.Object
  extended by edu.internet2.middleware.grouper.grouperUi.beans.json.GuiScreenAction
All Implemented Interfaces:
Serializable

public class GuiScreenAction
extends Object
implements Serializable

one action for screen (response has many actions in a list

Author:
mchyzer
See Also:
Serialized Form

Constructor Summary
GuiScreenAction()
          default constructor
 
Method Summary
 String getAlert()
          alert to show on screen
 Boolean getAlertCentered()
          if the alert should be centered or not (default true)
 String getAssignmentName()
          the place in object model to assign
 Object getAssignmentObject()
          the object to assign
 Boolean getCloseModal()
          if the current modal window should be closed
 String getDialog()
          dialog to show on screen
 String getFormFieldName()
          if changing the value of a form field, this is the name
 List<String> getFormFieldValues()
          if changing the value of a form field, these are the values (list of size one for single values)
 String getHideShowNameToHide()
          hide show name to hide
 String getHideShowNameToShow()
          hide show name to show
 String getHideShowNameToToggle()
          hide show name to toggle
 String getInnerHtml()
           
 String getInnerHtmlJqueryHandle()
           
 List<GuiOption> getOptionValues()
          option values to replace (use with optionValuesSelectName) (could be null to blank it out)
 String getOptionValuesSelectName()
          select name to replace options
 String getScript()
          run a javascript
static GuiScreenAction newAlert(String theAlert)
          construct with the name and object
static GuiScreenAction newAlert(String theAlert, boolean theAlertCentered)
          construct with the name and object
static GuiScreenAction newAlertFromJsp(String jspName)
          construct with JSP name
static GuiScreenAction newAssign(String theAssignmentName, Object theAssignmentObject)
          construct with the name and object
static GuiScreenAction newCloseModal()
          construct with an instruction to close the current modal window if open
static GuiScreenAction newDialogFromJsp(String jspName)
          construct with JSP name
static GuiScreenAction newFormFieldValue(String theFormFieldName, String theFormFieldValue)
          construct with form field to change by name and value
static GuiScreenAction newFormFieldValues(String theFormFieldName, List<String> theFormFieldValues)
          construct with form field to change by name and values (e.g.
static GuiScreenAction newHideShowNameToHide(String theHideShowName)
          construct with hide show name to hide
static GuiScreenAction newHideShowNameToShow(String theHideShowName)
          construct with hide show name to show
static GuiScreenAction newHideShowNameToToggle(String theHideShowName)
          construct with hide show name to toggle
static GuiScreenAction newInnerHtml(String htmlReplaceJqueryHandle1, String html)
          construct with the name and object
static GuiScreenAction newInnerHtmlFromJsp(String htmlReplaceJqueryHandle1, String jspName)
          construct with the name and JSP name
static GuiScreenAction newOptionValues(String theSelectName, List<GuiOption> theOptionValues)
          construct with the name and object
static GuiScreenAction newScript(String theScript)
          construct with the name and object
 void setAlert(String alert1)
          alert to show on screen
 void setAlertCentered(Boolean alertCentered1)
          if the alert should be centered or not (default true)
 void setAssignmentName(String assignmentName1)
          the place in object model to assign
 void setAssignmentObject(Object assignmentObject1)
          the object to assign
 void setCloseModal(Boolean closeModal1)
          if the current modal window should be closed
 void setDialog(String dialog1)
          dialog to show on screen
 void setFormFieldName(String formFieldName1)
          if changing the value of a form field, this is the name
 void setFormFieldValues(List<String> formFieldValue1)
          if changing the value of a form field, these are the values (list of size one for single values)
 void setHideShowNameToHide(String hideShowNameToHide1)
          hide show name to hide
 void setHideShowNameToShow(String hideShowNameToShow1)
          hide show name to show
 void setHideShowNameToToggle(String hideShowNameToToggle1)
          hide show name to toggle
 void setInnerHtml(String htmlReplaceHtml1)
           
 void setInnerHtmlJqueryHandle(String htmlReplaceJqueryHandle1)
           
 void setOptionValues(List<GuiOption> optionValues1)
          option values to replace (use with optionValuesSelectName) (could be null to blank it out)
 void setOptionValuesSelectName(String optionValuesSelectName1)
          select name to replace options
 void setScript(String script1)
          run a javascript
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GuiScreenAction

public GuiScreenAction()
default constructor

Method Detail

getFormFieldName

public String getFormFieldName()
if changing the value of a form field, this is the name

Returns:
the formFieldName

setFormFieldName

public void setFormFieldName(String formFieldName1)
if changing the value of a form field, this is the name

Parameters:
formFieldName1 - the formFieldName to set

getFormFieldValues

public List<String> getFormFieldValues()
if changing the value of a form field, these are the values (list of size one for single values)

Returns:
the formFieldValue

setFormFieldValues

public void setFormFieldValues(List<String> formFieldValue1)
if changing the value of a form field, these are the values (list of size one for single values)

Parameters:
formFieldValue1 - the formFieldValue to set

getOptionValues

public List<GuiOption> getOptionValues()
option values to replace (use with optionValuesSelectName) (could be null to blank it out)

Returns:
the optionValues

setOptionValues

public void setOptionValues(List<GuiOption> optionValues1)
option values to replace (use with optionValuesSelectName) (could be null to blank it out)

Parameters:
optionValues1 - the optionValues to set

getOptionValuesSelectName

public String getOptionValuesSelectName()
select name to replace options

Returns:
the optionValuesSelectName

setOptionValuesSelectName

public void setOptionValuesSelectName(String optionValuesSelectName1)
select name to replace options

Parameters:
optionValuesSelectName1 - the optionValuesSelectName to set

getDialog

public String getDialog()
dialog to show on screen

Returns:
the dialog

setDialog

public void setDialog(String dialog1)
dialog to show on screen

Parameters:
dialog1 - the dialog to set

getAlert

public String getAlert()
alert to show on screen

Returns:
the alert

setAlert

public void setAlert(String alert1)
alert to show on screen

Parameters:
alert1 - the alert to set

getAlertCentered

public Boolean getAlertCentered()
if the alert should be centered or not (default true)

Returns:
the alertCentered

setAlertCentered

public void setAlertCentered(Boolean alertCentered1)
if the alert should be centered or not (default true)

Parameters:
alertCentered1 - the alertCentered to set

getHideShowNameToShow

public String getHideShowNameToShow()
hide show name to show

Returns:
the hideShowNameToShow

setHideShowNameToShow

public void setHideShowNameToShow(String hideShowNameToShow1)
hide show name to show

Parameters:
hideShowNameToShow1 - the hideShowNameToShow to set

getHideShowNameToHide

public String getHideShowNameToHide()
hide show name to hide

Returns:
the hideShowNameToHide

setHideShowNameToHide

public void setHideShowNameToHide(String hideShowNameToHide1)
hide show name to hide

Parameters:
hideShowNameToHide1 - the hideShowNameToHide to set

getHideShowNameToToggle

public String getHideShowNameToToggle()
hide show name to toggle

Returns:
the hideShowNameToToggle

setHideShowNameToToggle

public void setHideShowNameToToggle(String hideShowNameToToggle1)
hide show name to toggle

Parameters:
hideShowNameToToggle1 - the hideShowNameToToggle to set

getInnerHtmlJqueryHandle

public String getInnerHtmlJqueryHandle()
Returns:
the htmlReplaceJqueryHandle

setInnerHtmlJqueryHandle

public void setInnerHtmlJqueryHandle(String htmlReplaceJqueryHandle1)
Parameters:
htmlReplaceJqueryHandle1 - the htmlReplaceJqueryHandle to set

getInnerHtml

public String getInnerHtml()
Returns:
the htmlReplaceHtml

setInnerHtml

public void setInnerHtml(String htmlReplaceHtml1)
Parameters:
htmlReplaceHtml1 - the htmlReplaceHtml to set

getScript

public String getScript()
run a javascript

Returns:
the script

setScript

public void setScript(String script1)
run a javascript

Parameters:
script1 - the script to set

newAssign

public static GuiScreenAction newAssign(String theAssignmentName,
                                        Object theAssignmentObject)
construct with the name and object

Parameters:
theAssignmentName -
theAssignmentObject -
Returns:
the action

newOptionValues

public static GuiScreenAction newOptionValues(String theSelectName,
                                              List<GuiOption> theOptionValues)
construct with the name and object

Parameters:
theSelectName - name of the select
theOptionValues - values to replace (could be null to blank it out
Returns:
the action

newFormFieldValue

public static GuiScreenAction newFormFieldValue(String theFormFieldName,
                                                String theFormFieldValue)
construct with form field to change by name and value

Parameters:
theFormFieldName -
theFormFieldValue -
Returns:
the action

newFormFieldValues

public static GuiScreenAction newFormFieldValues(String theFormFieldName,
                                                 List<String> theFormFieldValues)
construct with form field to change by name and values (e.g. for checkboxes or multiselect)

Parameters:
theFormFieldName -
theFormFieldValues -
Returns:
the action

newHideShowNameToShow

public static GuiScreenAction newHideShowNameToShow(String theHideShowName)
construct with hide show name to show

Parameters:
theHideShowName -
Returns:
the action

newHideShowNameToHide

public static GuiScreenAction newHideShowNameToHide(String theHideShowName)
construct with hide show name to hide

Parameters:
theHideShowName -
Returns:
the action

newHideShowNameToToggle

public static GuiScreenAction newHideShowNameToToggle(String theHideShowName)
construct with hide show name to toggle

Parameters:
theHideShowName -
Returns:
the action

newAlert

public static GuiScreenAction newAlert(String theAlert)
construct with the name and object

Parameters:
theAlert -
Returns:
the action

newAlert

public static GuiScreenAction newAlert(String theAlert,
                                       boolean theAlertCentered)
construct with the name and object

Parameters:
theAlert -
theAlertCentered - if the alert should be centered
Returns:
the action

newScript

public static GuiScreenAction newScript(String theScript)
construct with the name and object

Parameters:
theScript -
Returns:
the action

newInnerHtmlFromJsp

public static GuiScreenAction newInnerHtmlFromJsp(String htmlReplaceJqueryHandle1,
                                                  String jspName)
construct with the name and JSP name

Parameters:
htmlReplaceJqueryHandle1 - e.g. #someId
jspName - e.g. /WEB-INF/templates/something.jsp
Returns:
the action

newAlertFromJsp

public static GuiScreenAction newAlertFromJsp(String jspName)
construct with JSP name

Parameters:
jspName - e.g. /WEB-INF/templates/something.jsp
Returns:
the action

newDialogFromJsp

public static GuiScreenAction newDialogFromJsp(String jspName)
construct with JSP name

Parameters:
jspName - e.g. /WEB-INF/templates/something.jsp
Returns:
the action

newCloseModal

public static GuiScreenAction newCloseModal()
construct with an instruction to close the current modal window if open

Returns:
the action

getAssignmentName

public String getAssignmentName()
the place in object model to assign

Returns:
the assignmentName

setAssignmentName

public void setAssignmentName(String assignmentName1)
the place in object model to assign

Parameters:
assignmentName1 - the assignmentName to set

getAssignmentObject

public Object getAssignmentObject()
the object to assign

Returns:
the assignmentObject

setAssignmentObject

public void setAssignmentObject(Object assignmentObject1)
the object to assign

Parameters:
assignmentObject1 - the assignmentObject to set

getCloseModal

public Boolean getCloseModal()
if the current modal window should be closed

Returns:
the closeModal

setCloseModal

public void setCloseModal(Boolean closeModal1)
if the current modal window should be closed

Parameters:
closeModal1 - the closeModal to set

newInnerHtml

public static GuiScreenAction newInnerHtml(String htmlReplaceJqueryHandle1,
                                           String html)
construct with the name and object

Parameters:
htmlReplaceJqueryHandle1 - e.g. #someId
html - is html to put on screen
Returns:
the action