Programmatically populate values in ADF Faces multiSelect component (af:selectManyCheckbox, af:selectManyChoice, af:selectManyListbox, af:selectManyShuttle)

ADF Faces provides some component to support multiple selection as af:selectManyListbox, af:selectManyCheckbox, af:selectManyChoice, af:selectManyShuttle
In this post we will see how to populate values in these component from managed bean using POJO
You can read my previous post on multiple selection that was about populating multiselect component using ADF BC and binding layer
Using Multiple Selection (selectManyListbox & selectManyCheckbox component) in ADF
Shuttle Component in Oracle ADF (Allow Multiple Selection)

See the step by step implementation-

• Create a Fusion Web Application and a managed bean in viewController
  
  
  


• Create a variable of type java.util.List in managed bean, and generate its accessors



    //List to show records in selectMany components
    List<SelectItem> allValuesList;

    public void setAllValuesList(List<SelectItem> allValuesList) {
        this.allValuesList = allValuesList;
    }

    public List<SelectItem> getAllValuesList() {
        return allValuesList;
    }



• This list contains value of type javax.faces.model.SelectItem; that is supported by af:selectManyCheckbox, af:selectManyChoice, af:selectManyListbox compoent



    //List to show records in selectMany components
    List<SelectItem> allValuesList;

    public void setAllValuesList(List<SelectItem> allValuesList) {
        this.allValuesList = allValuesList;
    }

    public List<SelectItem> getAllValuesList() {
        if (allValuesList == null) {
            allValuesList = new ArrayList<SelectItem>();
            allValuesList.add(new SelectItem(1, "India"));
            allValuesList.add(new SelectItem(2, "Australia"));
            allValuesList.add(new SelectItem(3, "America"));
            allValuesList.add(new SelectItem(4, "United Kingdom"));
        }
        return allValuesList;
    }



• See how to add this list reference to  af:selectManyCheckbox component, just drag n drop component on page





• Set managed bean list reference to selectManyCheckbox component, records stored in this list will be populated in component





• Suppose I have to show some record as selected by default on page load so for this requirement created another List in managed bean and added it to value property of selectManyCheckbox component
  Value property of component refers only selected records but selectItems component refers all records of component



    //List to show selected values in selectMany Component
    List selectedValues;

    public void setSelectedValues(List selectedValues) {
        this.selectedValues = selectedValues;
    }

    public List getSelectedValues() {
        if (selectedValues == null) {
            selectedValues = new ArrayList();
            selectedValues.add(1);
            selectedValues.add(3);
            System.out.println("List is-" + selectedValues);
        }
        return selectedValues;
    }


See af:selectManyCheckbox source -



<af:selectManyCheckbox id="smc1" value="#{viewScope.ProgSelectManyComp.selectedValues}">
                                    <f:selectItems value="#{viewScope.ProgSelectManyComp.allValuesList}" id="si1"/>
                                </af:selectManyCheckbox>



• Now run this application and see component on page





• Following same steps i have three more component on page , all 3 adf faces component support multiple selection
  af:selectManyChoice-
  
  

  <af:selectManyChoice label="Label 1" id="smc2"
                                                       value="#{viewScope.ProgSelectManyComp.selectedValues}"
                                                       simple="true">
                                      <f:selectItems value="#{viewScope.ProgSelectManyComp.allValuesList}" id="si2"/>
                                  </af:selectManyChoice>
  

  
  
  af:selectManyListbox-
  
  

  <af:selectManyListbox label="Label 1" id="sml1"
                                                        value="#{viewScope.ProgSelectManyComp.selectedValues}"
                                                        simple="true">
                                      <f:selectItems value="#{viewScope.ProgSelectManyComp.allValuesList}" id="si3"/>
                                  </af:selectManyListbox>
  

  
  
  af:selectManyShuttle-
  
  

   <af:selectManyShuttle label="Label 1" id="sos1" simple="true"
                                                         value="#{viewScope.ProgSelectManyComp.selectedValues}"
                                                         contentStyle="width:50px;">
                                      <f:selectItems value="#{viewScope.ProgSelectManyComp.allValuesList}" id="si4"/>
                                  </af:selectManyShuttle>
  



• All 4 components on page are populated using same List, this is just an example to show that all 4 components share same strucutre, run this application and see 




Thanks, Happy Learning :)
Download- Sample ADF Application

ADF Basics: Delete child records on delete of parent record, Overriding remove() in EntityObject class

This post is about one basic question of Master-Detail relation between business components
How to delete all child records on delete of parent record ?
So answer is quite simple , see the steps how to achieve this?

• Create a Fusion Web Application and prepare model project using Departments and Employees table of HRSchema.
  you can see multiple associations and viewLinks are created automatically due to foreign key relation in database





• Here Departments is parent table and Employees is child, so there is an association between both entity objects , open this association and goto Association Properties . Now you can see source and destination accessor name that are created in both entity objects







• Next step is to create EntityObject java class. To do this open Departments entity object -- go to java section-- click on edit icon and check the box to create class and required methods
  See Accessors and Remove Method will be created in this class





• Open DepartmentsEOImpl class and check there is a method that returns RowIterator of Employees (this is Accessor)



    /**
     * @return the associated entity oracle.jbo.RowIterator.
     */
    public RowIterator getEmployeesEO1() {
        return (RowIterator)getAttributeInternal(EMPLOYEESEO1);
    }



• Now locate remove method in EOImpl, this method is called every time when delete operation for Departments is executed so add this code to remove(); method



    /**
     * Add entity remove logic in this method.
     */
    public void remove() {
        //Get all Employees of currenlty selected Department
        RowIterator employees = getEmployeesEO1();
        while (employees.hasNext()) {
            //Delete all Employees
            employees.next().remove();
        }
        //Delete Department itself after deleting all Employees associated with it
        super.remove();
    }

This is how we can make use EntityObject class and Association accessors, in the same way other operation can be performed as updating all child rows, sum of a column of child records etc
Thnaks , Happy Learning :)

Using captcha with ADF Faces (Integrate Kaptcha project with Oracle ADF)

First of all wishing a very Happy New Year to all of you, learn more n more ADF this year :)

This post is about using captcha challenge in ADF Faces, captcha is used to determine whether user is a human or not
CAPTCHA stands for-Completely Automated Public Turing test to tell Computers and Humans Apart
Frank Nimphius posted about 'captcha with ADF Faces' using "Simple Captcha" project.
You can read complete article- http://www.oracle.com/technetwork/developer-tools/jdev/captcha-099103.html



For this post I am using modern version of simplecaptcha project called Kaptcha, project provides a servlet that is responsible for generating captcha image and there are various configuration parameters to change look n feel of captcha image
See project documentation - https://code.google.com/p/kaptcha/
Download jar file- https://code.google.com/p/kaptcha/downloads/list

Now see the steps to integrate Kaptcha project with Oracle ADF

• Create a FusionWeb Application, attach kaptcha-2.3.2 jar to viewController project, also see How to use "Kaptcha"-https://code.google.com/p/kaptcha/wiki/HowToUse





• Next step is to add kaptcha servlet reference in web.xml file



 <servlet>
        <servlet-name>Kaptcha</servlet-name>
        <servlet-class>com.google.code.kaptcha.servlet.KaptchaServlet</servlet-class>
    </servlet>
    <servlet-mapping>
        <servlet-name>Kaptcha</servlet-name>
        <url-pattern>/kaptchaimage</url-pattern>
    </servlet-mapping>



• Add an af:image on page to show captcha, image source is referenced from servlet mapping



<af:image id="i1" partialtriggers="l1" shortdesc="Captcha" source="/kaptchaimage">



• Default configuration for captcha image is completed , I have added an af:inputText and button on page to enter captcha result .



<af:panelBox text="Captcha Demo- www.awasthiashish.com" id="pb1" showDisclosure="false"
                                 inlineStyle="width:350px;">
                        <f:facet name="toolbar"/>
                        <af:spacer width="0" height="10" id="s3"/>
                        <af:panelFormLayout id="pfl1">
                            <af:panelGroupLayout id="pgl1" layout="horizontal">
                                <af:image source="/kaptchaimage" id="i1" partialTriggers="l1" shortDesc="Captcha"/>
                                <af:spacer width="10" height="0" id="s4"/>
                                <af:link id="l1" icon="#{resource['images:reload.png']}" shortDesc="Refresh Captcha"/>
                            </af:panelGroupLayout>
                            <af:inputText label="Enter text" id="it1" binding="#{ReadCaptchaBean.entrdCaptchaBind}"
                                          contentStyle="font-weight:bold;"/>
                            <af:button text="Submit" id="b1" actionListener="#{ReadCaptchaBean.readCaptchAction}"/>
                        </af:panelFormLayout>
                    </af:panelBox>



• Run application and see how captcha image is appearing on page





• It looks good :-), now see the managed bean code written in submit button's action. This code checks actual captcha value with entered value



    //Binding of inputText to get entered value
    private RichInputText entrdCaptchaBind;

    public void setEntrdCaptchaBind(RichInputText entrdCaptchaBind) {
        this.entrdCaptchaBind = entrdCaptchaBind;
    }

    public RichInputText getEntrdCaptchaBind() {
        return entrdCaptchaBind;
    }
    
    /**Method to check whether entered value is correct or not
     * @param actionEvent
     */
    public void readCaptchaAction(ActionEvent actionEvent) {
        FacesContext fctx = FacesContext.getCurrentInstance();
        ExternalContext ectx = fctx.getExternalContext();
        HttpServletRequest request = (HttpServletRequest) ectx.getRequest();
        //KAPTCHA_SESSION_KEY- The value for the kaptcha is generated and is put into the HttpSession. This is the key value for that item in the session.
        String kaptchaExpected =
            (String) request.getSession().getAttribute(com.google.code.kaptcha.Constants.KAPTCHA_SESSION_KEY);
        //Get entered value of captcha using inputText binding
        String kaptchaReceived = entrdCaptchaBind.getValue().toString();
        System.out.println("Entered Value-" + kaptchaReceived + " Expected Value-" + kaptchaExpected);
        if (kaptchaReceived == null || !kaptchaReceived.equalsIgnoreCase(kaptchaExpected)) {
            FacesMessage errMsg = new FacesMessage("Invalid Value");
            errMsg.setDetail("Incorrect captcha value- Not Human");
            errMsg.setSeverity(FacesMessage.SEVERITY_ERROR);
            fctx.addMessage(entrdCaptchaBind.getClientId(), errMsg);
        } else {
            FacesMessage errMsg = new FacesMessage("Correct Value");
            errMsg.setDetail("Hello this is the right guess");
            errMsg.setSeverity(FacesMessage.SEVERITY_INFO);
            fctx.addMessage(entrdCaptchaBind.getClientId(), errMsg);
        }
    }



• Again run this application and enter value for captcha








• So it is working , now to change captcha image added a link with partialSubmit=false and set partial trigger property on af:image.





• Kaptcha integration with Oracle ADF is complete and it is working properly  now if you want to modify captcha look n feel then add some init-param (configuration parameter) in web.xml file.
  See complete list of configuration parameters- https://code.google.com/p/kaptcha/wiki/ConfigParameters
  I have changed some parameters value in web.xml , see changed source of web.xml and captcha output



<servlet>
        <servlet-name>Kaptcha</servlet-name>
        <servlet-class>com.google.code.kaptcha.servlet.KaptchaServlet</servlet-class>
        <init-param>
            <param-name>kaptcha.border</param-name>
            <param-value>yes</param-value>
        </init-param>
        <init-param>
            <param-name>kaptcha.border.color</param-name>
            <param-value>red</param-value>
        </init-param>
        <init-param>
            <param-name>kaptcha.border.thickness</param-name>
            <param-value>1</param-value>
        </init-param>
        <init-param>
            <param-name>kaptcha.image.width</param-name>
            <param-value>250</param-value>
        </init-param>
        <init-param>
            <param-name>kaptcha.image.height</param-name>
            <param-value>60</param-value>
        </init-param>
        <init-param>
            <param-name>kaptcha.textproducer.font.size</param-name>
            <param-value>35</param-value>
        </init-param>
        <init-param>
            <param-name>kaptcha.textproducer.font.color</param-name>
            <param-value>red</param-value>
        </init-param>
        <init-param>
            <param-name>kaptcha.background.clear.from</param-name>
            <param-value>orange</param-value>
        </init-param>
        <init-param>
            <param-name>kaptcha.textproducer.char.length</param-name>
            <param-value>7</param-value>
        </init-param>
    </servlet>
    <servlet-mapping>
        <servlet-name>Kaptcha</servlet-name>
        <url-pattern>/kaptchaimage</url-pattern>
    </servlet-mapping>


again run this application and check output


Thanks, Happy Learning :)
Download-Sample ADF Application