FormDesignElementPicker.java

/*
 * � Copyright IBM Corp. 2011
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"); 
 * you may not use this file except in compliance with the License. 
 * You may obtain a copy of the License at:
 * 
 * http://www.apache.org/licenses/LICENSE-2.0 
 * 
 * Unless required by applicable law or agreed to in writing, software 
 * distributed under the License is distributed on an "AS IS" BASIS, 
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 
 * implied. See the License for the specific language governing 
 * permissions and limitations under the License.
 */
package com.ibm.xsp.extlib.designer.tooling.propeditor;

import java.util.ArrayList;

import com.ibm.commons.iloader.node.lookups.api.StringLookup;
import com.ibm.commons.util.StringUtil;
import com.ibm.designer.domino.ide.resources.extensions.DesignerDesignElement;
import com.ibm.designer.domino.ui.commons.extensions.DesignerResource;

/**
 * Form Design Element Picker. This property editor will provide a comboBox containing all the Form
 * Design Elements in the Designer Project. The display labels take the form "Form Name - Last Alias"
 * When one of the forms is selected, the last alias (or form name if no alias is specified) will be
 * set in source.   
 */
public class FormDesignElementPicker extends AbstractDesignElementPicker {

	private static String FORM_NAME_ALIAS_SEPARATOR = " - ";
	
	/*
	 * (non-Javadoc)
	 * @see com.ibm.xsp.extlib.designer.tooling.propeditor.AbstractDesignElementPicker#getDesignElementIDs()
	 */
	@Override
	protected String[] getDesignElementIDs() {
		return new String[]{DesignerResource.TYPE_FORM};
	}

	/*
	 * (non-Javadoc)
	 * @see com.ibm.xsp.extlib.designer.tooling.propeditor.AbstractDesignElementPicker#createDesignElementLookup(com.ibm.designer.domino.ide.resources.extensions.DesignerDesignElement[])
	 */
	@Override
	protected StringLookup createDesignElementLookup(DesignerDesignElement[] designElements) {
		ArrayList<String> codes = new ArrayList<String>();
    	ArrayList<String> labels = new ArrayList<String>();
		
    	for(int i=0; i<designElements.length; i++){
			DesignerDesignElement form = designElements[i];
			String formName = form.getName();
			String formAlias = super.getAliasToDisplay(form);
			
			if(StringUtil.isNotEmpty(formName)){
				String label = formName;
				if(StringUtil.isNotEmpty(formAlias)){
					label = label + FORM_NAME_ALIAS_SEPARATOR + formAlias;
					labels.add(label);
					codes.add(formAlias);
				}
				else{
					labels.add(label);
					codes.add(formName);
				}
			}
		}
		
		//ensure consistency of our codes and labels before creating a StringLookup from them.
    	if(codes.size()>0 && labels.size()>0 && codes.size()==labels.size()){
    		String[] codesArray = codes.toArray(new String[codes.size()]);
    		String[] labelsArray = labels.toArray(new String[labels.size()]);
    		if(null != codesArray && null != labelsArray && codesArray.length>0 && labelsArray.length>0 && codesArray.length==labelsArray.length){
    			return new StringLookup(codesArray,labelsArray);
    		}
    	}
    	return null;
	}
    
}