BranchMainCtrl.java

package de.forsthaus.webui.branch;

import java.io.IOException;
import java.io.Serializable;
import java.lang.reflect.InvocationTargetException;

import org.apache.log4j.Logger;
import org.springframework.dao.DataAccessException;
import org.zkoss.util.resource.Labels;
import org.zkoss.zk.ui.Component;
import org.zkoss.zk.ui.Path;
import org.zkoss.zk.ui.event.Event;
import org.zkoss.zk.ui.event.EventListener;
import org.zkoss.zk.ui.event.EventQueues;
import org.zkoss.zk.ui.event.Events;
import org.zkoss.zk.ui.event.ForwardEvent;
import org.zkoss.zkplus.databind.BindingListModelList;
import org.zkoss.zul.Button;
import org.zkoss.zul.Checkbox;
import org.zkoss.zul.Messagebox;
import org.zkoss.zul.Tab;
import org.zkoss.zul.Tabbox;
import org.zkoss.zul.Tabpanel;
import org.zkoss.zul.Textbox;
import org.zkoss.zul.Window;

import com.trg.search.Filter;

import de.forsthaus.UserWorkspace;
import de.forsthaus.backend.model.Branche;
import de.forsthaus.backend.service.BrancheService;
import de.forsthaus.backend.util.HibernateSearchObject;
import de.forsthaus.backend.util.ZksampleBeanUtils;
import de.forsthaus.webui.branch.report.BranchSimpleDJReport;
import de.forsthaus.webui.util.ButtonStatusCtrl;
import de.forsthaus.webui.util.GFCBaseCtrl;
import de.forsthaus.webui.util.MultiLineMessageBox;
import de.forsthaus.webui.util.ZksampleCommonUtils;
import de.forsthaus.webui.util.ZksampleMessageUtils;

/**
 * +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++<br>
 * Main controller for the branch main module.<br>
 * <br>
 * zul-file: /WEB-INF/pages/branch/branchMain.zul.<br>
 * <br>
 * <b>WORKS with the annotated databinding mechanism.</b><br>
 * This class creates the Tabs + TabPanels. The components/data to all tabs are
 * created on demand on first time selecting the tab.<br>
 * This controller holds all getters/setters for the used databinding beans/sets
 * in all related tabs. In the child tabs controllers their databinding
 * setters/getters pointed to this mainTabController.<br>
 * +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++<br>
 * <br>
 * 
 * @changes 07/03/2010: sge modified for zk5.x with complete Annotated
 *          Databinding.<br>
 * 
 *          Managed tabs:<br>
 *          - BranchListCtrl = Branch List / BranchenListe<br>
 *          - BranchDetailCtrl = Branch Details / BranchenDetails<br>
 * 
 * @author bbruhns
 * @author Stephan Gerth
 */
public class BranchMainCtrl extends GFCBaseCtrl implements Serializable {

	private static final long serialVersionUID = 1L;
	private static final Logger logger = Logger.getLogger(BranchMainCtrl.class);

	/*
	 * ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
	 * All the components that are defined here and have a corresponding
	 * component with the same 'id' in the zul-file are getting autowired by our
	 * 'extends GFCBaseCtrl' GenericForwardComposer.
	 * ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
	 */
	protected Window windowBranchMain; // autowired

	// Tabs
	protected Tabbox tabbox_BranchMain; // autowired
	protected Tab tabBranchList; // autowired
	protected Tab tabBranchDetail; // autowired
	protected Tabpanel tabPanelBranchList; // autowired
	protected Tabpanel tabPanelBranchDetail; // autowired

	// filter components
	protected Checkbox checkbox_Branch_ShowAll; // autowired
	protected Textbox tb_Branch_Name; // aurowired

	// checkRights
	protected Button button_BranchMain_Search_BranchName;

	// Button controller for the CRUD buttons
	private final String btnCtroller_ClassPrefix = "button_BranchMain_";
	private ButtonStatusCtrl btnCtrlBranch;
	protected Button btnNew; // autowired
	protected Button btnEdit; // autowired
	protected Button btnDelete; // autowired
	protected Button btnSave; // autowired
	protected Button btnCancel; // autowired

	protected Button btnFirst; // autowire
	protected Button btnPrevious; // autowire
	protected Button btnNext; // autowire
	protected Button btnLast; // autowire

	protected Button btnPrint; // autowire

	protected Button btnHelp;

	// Tab-Controllers for getting access to their components/dataBinders
	private BranchListCtrl branchListCtrl;
	private BranchDetailCtrl branchDetailCtrl;

	// Databinding
	private Branche selectedBranche;
	private BindingListModelList branches;

	// ServiceDAOs / Domain Classes
	private BrancheService brancheService;

	// always a copy from the bean before modifying. Used for reseting
	private Branche originalBranche;

	/**
	 * default constructor.<br>
	 */
	public BranchMainCtrl() {
		super();
	}

	@Override
	public void doAfterCompose(Component window) throws Exception {
		super.doAfterCompose(window);

		/**
		 * 1. Set an 'alias' for this composer name to access it in the
		 * zul-file.<br>
		 * 2. Set the parameter 'recurse' to 'false' to avoid problems with
		 * managing more than one zul-file in one page. Otherwise it would be
		 * overridden and can ends in curious error messages.
		 */
		this.self.setAttribute("controller", this, false);
	}

	// +++++++++++++++++++++++++++++++++++++++++++++++++ //
	// +++++++++++++++ Component Events ++++++++++++++++ //
	// +++++++++++++++++++++++++++++++++++++++++++++++++ //

	/**
	 * Automatically called method from zk.
	 * 
	 * @param event
	 * @throws Exception
	 */
	public void onCreate$windowBranchMain(Event event) throws Exception {
		// logger.debug(event.toString());

		// create the Button Controller. Disable not used buttons during working
		this.btnCtrlBranch = new ButtonStatusCtrl(getUserWorkspace(), btnCtroller_ClassPrefix, true, null, btnPrint, btnFirst, btnPrevious, btnNext, btnLast, btnNew, btnEdit, btnDelete, btnSave,
				btnCancel, null);

		doCheckRights();

		/**
		 * Initiate the first loading by selecting the customerList tab and
		 * create the components from the zul-file.
		 */
		this.tabBranchList.setSelected(true);
		if (this.tabPanelBranchList != null) {
			ZksampleCommonUtils.createTabPanelContent(this.tabPanelBranchList, this, "ModuleMainController", "/WEB-INF/pages/branch/branchList.zul");
		}

		// Set the buttons for editMode
		this.btnCtrlBranch.setInitEdit();
	}

	/**
	 * When the tab 'tabBranchList' is selected.<br>
	 * Loads the zul-file into the tab.
	 * 
	 * @param event
	 * @throws IOException
	 */
	public void onSelect$tabBranchList(Event event) throws IOException {
		// logger.debug(event.toString());

		// Check if the tabpanel is already loaded
		if (this.tabPanelBranchList.getFirstChild() != null) {
			this.tabBranchList.setSelected(true);
			return;
		}

		if (this.tabPanelBranchList != null) {
			ZksampleCommonUtils.createTabPanelContent(this.tabPanelBranchList, this, "ModuleMainController", "/WEB-INF/pages/branch/branchList.zul");
		}
	}

	/**
	 * When the tab 'tabPanelBranchDetail' is selected.<br>
	 * Loads the zul-file into the tab.
	 * 
	 * @param event
	 * @throws IOException
	 */
	public void onSelect$tabBranchDetail(Event event) throws IOException {
		// logger.debug(event.toString());

		// Check if the tabpanel is already loaded
		if (this.tabPanelBranchDetail.getFirstChild() != null) {
			this.tabBranchDetail.setSelected(true);

			// refresh the Binding mechanism
			getBranchDetailCtrl().setBranche(getSelectedBranche());
			getBranchDetailCtrl().getBinder().loadAll();
			return;
		}

		if (this.tabPanelBranchDetail != null) {
			ZksampleCommonUtils.createTabPanelContent(this.tabPanelBranchDetail, this, "ModuleMainController", "/WEB-INF/pages/branch/branchDetail.zul");
		}
	}

	/**
	 * when the checkBox 'Show All' for filtering is checked. <br>
	 * 
	 * @param event
	 */
	public void onCheck$checkbox_Branch_ShowAll(Event event) {
		doBranchListShowAll(event);
	}

	/**
	 * When the "search for branch name" button is clicked.
	 * 
	 * @param event
	 * @throws Exception
	 */
	public void onClick$button_BranchMain_Search_BranchName(Event event) throws Exception {
		doBranchListSearchLikeBranchName(event);
	}

	/**
	 * When the "help" button is clicked.
	 * 
	 * @param event
	 * @throws InterruptedException
	 */
	public void onClick$btnHelp(Event event) throws InterruptedException {
		doHelp(event);
	}

	/**
	 * When the "new" button is clicked.
	 * 
	 * @param event
	 * @throws InterruptedException
	 */
	// @Secured( { "button_BranchMain_btnNew" })
	public void onClick$btnNew(Event event) throws InterruptedException {
		doNew(event);
	}

	/**
	 * When the "save" button is clicked.
	 * 
	 * @param event
	 * @throws InterruptedException
	 */
	public void onClick$btnSave(Event event) throws InterruptedException {
		doSave(event);
	}

	/**
	 * When the "cancel" button is clicked.
	 * 
	 * @param event
	 * @throws InterruptedException
	 */
	public void onClick$btnEdit(Event event) throws InterruptedException {
		doEdit(event);
	}

	/**
	 * When the "delete" button is clicked.
	 * 
	 * @param event
	 * @throws InterruptedException
	 */
	public void onClick$btnDelete(Event event) throws InterruptedException {
		doDelete(event);
	}

	/**
	 * When the "cancel" button is clicked.
	 * 
	 * @param event
	 * @throws InterruptedException
	 */
	public void onClick$btnCancel(Event event) throws InterruptedException {
		doCancel(event);
	}

	/**
	 * when the "refresh" button is clicked. <br>
	 * <br>
	 * 
	 * @param event
	 * @throws InterruptedException
	 */
	public void onClick$btnRefresh(Event event) throws InterruptedException {
		doResizeSelectedTab(event);
	}

	/**
	 * when the "print branches list" button is clicked.
	 * 
	 * @param event
	 * @throws InterruptedException
	 */
	public void onClick$btnPrint(Event event) throws InterruptedException {
		final Window win = (Window) Path.getComponent("/outerIndexWindow");
		new BranchSimpleDJReport(win);
	}

	/**
	 * when the "go first record" button is clicked.
	 * 
	 * @param event
	 * @throws InterruptedException
	 */
	public void onClick$btnFirst(Event event) throws InterruptedException {
		doSkip(event);
	}

	/**
	 * when the "go previous record" button is clicked.
	 * 
	 * @param event
	 * @throws InterruptedException
	 */
	public void onClick$btnPrevious(Event event) throws InterruptedException {
		doSkip(event);
	}

	/**
	 * when the "go next record" button is clicked.
	 * 
	 * @param event
	 * @throws InterruptedException
	 */
	public void onClick$btnNext(Event event) throws InterruptedException {
		doSkip(event);
	}

	/**
	 * when the "go last record" button is clicked.
	 * 
	 * @param event
	 * @throws InterruptedException
	 */
	public void onClick$btnLast(Event event) throws InterruptedException {
		doSkip(event);
	}

	// +++++++++++++++++++++++++++++++++++++++++++++++++ //
	// +++++++++++++++++ Business Logic ++++++++++++++++ //
	// +++++++++++++++++++++++++++++++++++++++++++++++++ //

	/**
	 * Filter the branch list with 'like branch name'. <br>
	 */
	private void doBranchListSearchLikeBranchName(Event event) throws Exception {
		// logger.debug(event.toString());

		// if not empty
		if (!this.tb_Branch_Name.getValue().isEmpty()) {
			this.checkbox_Branch_ShowAll.setChecked(false); // unCheck

			if (getBranchListCtrl().getBinder() != null) {

				// ++ create a searchObject and init sorting ++//
				final HibernateSearchObject<Branche> searchObjBranch = new HibernateSearchObject<Branche>(Branche.class, getBranchListCtrl().getCountRows());
				searchObjBranch.addFilter(new Filter("braBezeichnung", "%" + this.tb_Branch_Name.getValue() + "%", Filter.OP_ILIKE));
				searchObjBranch.addSort("braBezeichnung", false);

				// Change the BindingListModel.
				getBranchListCtrl().getPagedBindingListWrapper().setSearchObject(searchObjBranch);

				// get the current Tab for later checking if we must change it
				final Tab currentTab = this.tabbox_BranchMain.getSelectedTab();

				// check if the tab is one of the Detail tabs. If so do not
				// change the selection of it
				if (!currentTab.equals(this.tabBranchList)) {
					this.tabBranchList.setSelected(true);
				} else {
					currentTab.setSelected(true);
				}
			}
		}
	}

	/**
	 * Removes all Filters from the branch list and shows all. <br>
	 * 
	 * @param event
	 */
	private void doBranchListShowAll(Event event) {
		// logger.debug(event.toString());

		// empty the text search boxes
		this.tb_Branch_Name.setValue(""); // clear

		if (getBranchListCtrl().getBinder() != null) {
			getBranchListCtrl().getPagedBindingListWrapper().clearFilters();

			// get the current Tab for later checking if we must change it
			final Tab currentTab = this.tabbox_BranchMain.getSelectedTab();

			// check if the tab is one of the Detail tabs. If so do not
			// change the selection of it
			if (!currentTab.equals(this.tabBranchList)) {
				this.tabBranchList.setSelected(true);
			} else {
				currentTab.setSelected(true);
			}
		}
	}

	/**
	 * 1. Cancel the current action.<br>
	 * 2. Reset the values to its origin.<br>
	 * 3. Set UI components back to readonly/disable mode.<br>
	 * 4. Set the buttons in edit mode.<br>
	 * 
	 * @param event
	 * @throws InterruptedException
	 */
	private void doCancel(Event event) throws InterruptedException {
		// logger.debug(event.toString());

		// reset to the original object
		doResetToInitValues();

		// check first, if the tabs are created
		if (getBranchDetailCtrl().getBinder() != null) {

			// refresh all dataBinder related controllers/components
			getBranchDetailCtrl().getBinder().loadAll();

			// set editable Mode
			getBranchDetailCtrl().doReadOnlyMode(true);

			this.btnCtrlBranch.setInitEdit();
		}
	}

	/**
	 * Sets all UI-components to writable-mode. Sets the buttons to edit-Mode.
	 * Checks first, if the NEEDED TABS with its contents are created. If not,
	 * than create it by simulate an onSelect() with calling Events.sendEvent()
	 * 
	 * @param event
	 * @throws InterruptedException
	 */
	private void doEdit(Event event) {
		// logger.debug(event.toString());

		// get the current Tab for later checking if we must change it
		final Tab currentTab = this.tabbox_BranchMain.getSelectedTab();

		// check first, if the tabs are created, if not than create it
		if (getBranchDetailCtrl() == null) {
			Events.sendEvent(new Event("onSelect", this.tabBranchDetail, null));
			// if we work with spring beanCreation than we must check a little
			// bit deeper, because the Controller are preCreated ?
		} else if (getBranchDetailCtrl().getBinder() == null) {
			Events.sendEvent(new Event("onSelect", this.tabBranchDetail, null));
		}

		// check if the tab is one of the Detail tabs. If so do not change the
		// selection of it
		if (!currentTab.equals(this.tabBranchDetail)) {
			this.tabBranchDetail.setSelected(true);
		} else {
			currentTab.setSelected(true);
		}

		// remember the old vars
		doStoreInitValues();

		this.btnCtrlBranch.setBtnStatus_Edit();

		getBranchDetailCtrl().doReadOnlyMode(false);

		// refresh the UI, because we can click the EditBtn from every tab.
		getBranchDetailCtrl().getBinder().loadAll();

		// set focus
		getBranchDetailCtrl().txtb_BranchText.focus();
	}

	/**
	 * Deletes the selected Bean from the DB.
	 * 
	 * @param event
	 * @throws InterruptedException
	 * @throws InterruptedException
	 */
	private void doDelete(Event event) throws InterruptedException {
		// logger.debug(event.toString());

		// check first, if the tabs are created, if not than create them
		if (getBranchDetailCtrl().getBinder() == null) {
			Events.sendEvent(new Event("onSelect", this.tabBranchDetail, null));
		}

		// check first, if the tabs are created
		if (getBranchDetailCtrl().getBinder() == null) {
			return;
		}

		final Branche aBranche = getSelectedBranche();

		// check for default demo data
		if (aBranche.getId() == 1033) {
			ZksampleMessageUtils.doShowNotAllowedForDemoRecords();
			return;
		}

		if (aBranche != null) {

			// Show a confirm box
			final String msg = Labels.getLabel("message.Question.Are_you_sure_to_delete_this_record") + "\n\n --> " + aBranche.getBraBezeichnung();
			final String title = Labels.getLabel("message.Deleting.Record");

			MultiLineMessageBox.doSetTemplate();
			if (MultiLineMessageBox.show(msg, title, Messagebox.YES | Messagebox.NO, Messagebox.QUESTION, true, new EventListener() {
				@Override
				public void onEvent(Event evt) {
					switch (((Integer) evt.getData()).intValue()) {
					case MultiLineMessageBox.YES:
						try {
							deleteBean();
						} catch (InterruptedException e) {
							// TODO Auto-generated catch block
							e.printStackTrace();
						}
						break; //
					case MultiLineMessageBox.NO:
						break; //
					}
				}

				// delete from database
				private void deleteBean() throws InterruptedException {
					try {
						getBrancheService().delete(aBranche);
					} catch (DataAccessException e) {
						ZksampleMessageUtils.showErrorMessage(e.getMostSpecificCause().toString());
					}

				}

			}

			) == MultiLineMessageBox.YES) {
			}

		}

		this.btnCtrlBranch.setInitEdit();

		setSelectedBranche(null);
		// refresh the list
		getBranchListCtrl().doFillListbox();

		// refresh all dataBinder related controllers
		getBranchDetailCtrl().getBinder().loadAll();
	}

	/**
	 * Saves all involved Beans to the DB.
	 * 
	 * @param event
	 * @throws InterruptedException
	 */
	private void doSave(Event event) throws InterruptedException {
		// logger.debug(event.toString());

		// save all components data in the several tabs to the bean
		getBranchDetailCtrl().getBinder().saveAll();

		try {
			// save it to database
			getBrancheService().saveOrUpdate(getBranchDetailCtrl().getBranche());
			// if saving is successfully than actualize the beans as
			// origins.
			doStoreInitValues();
			// refresh the list
			getBranchListCtrl().doFillListbox();
			// later refresh StatusBar
			Events.postEvent("onSelect", getBranchListCtrl().getListBoxBranch(), getSelectedBranche());

			// show the objects data in the statusBar
			final String str = getSelectedBranche().getBraBezeichnung();
			EventQueues.lookup("selectedObjectEventQueue", EventQueues.DESKTOP, true).publish(new Event("onChangeSelectedObject", null, str));

		} catch (final DataAccessException e) {
			ZksampleMessageUtils.showErrorMessage(e.getMostSpecificCause().toString());

			// Reset to init values
			doResetToInitValues();

			return;

		} finally {
			this.btnCtrlBranch.setInitEdit();
			getBranchDetailCtrl().doReadOnlyMode(true);
		}
	}

	/**
	 * Sets all UI-components to writable-mode. Stores the current Beans as
	 * originBeans and get new Objects from the backend.
	 * 
	 * @param event
	 * @throws InterruptedException
	 * @throws InterruptedException
	 */
	private void doNew(Event event) throws InterruptedException {
		// logger.debug(event.toString());

		// check first, if the tabs are created
		if (getBranchDetailCtrl() == null) {
			Events.sendEvent(new Event("onSelect", this.tabBranchDetail, null));
			// if we work with spring beanCreation than we must check a little
			// bit deeper, because the Controller are preCreated ?
		} else if (getBranchDetailCtrl().getBinder() == null) {
			Events.sendEvent(new Event("onSelect", this.tabBranchDetail, null));
		}

		// remember the current object
		doStoreInitValues();

		/** !!! DO NOT BREAK THE TIERS !!! */
		// We don't create a new DomainObject() in the frontend.
		// We GET it from the backend.
		final Branche aBranche = getBrancheService().getNewBranche();

		// set the beans in the related databinded controllers
		getBranchDetailCtrl().setBranche(aBranche);
		getBranchDetailCtrl().setSelectedBranche(aBranche);

		// Refresh the binding mechanism
		getBranchDetailCtrl().setSelectedBranche(getSelectedBranche());
		getBranchDetailCtrl().getBinder().loadAll();

		// set editable Mode
		getBranchDetailCtrl().doReadOnlyMode(false);

		// set the ButtonStatus to New-Mode
		this.btnCtrlBranch.setInitNew();

		this.tabBranchDetail.setSelected(true);
		// set focus
		getBranchDetailCtrl().txtb_BranchText.focus();

	}

	/**
	 * Skip/Leaf through the models data according the navigation buttons and
	 * selected the according row in the listbox.
	 * 
	 * @param event
	 */
	private void doSkip(Event event) {

		// get the model and the current selected record
		BindingListModelList blml = (BindingListModelList) getBranchListCtrl().getListBoxBranch().getModel();

		// check if data exists
		if (blml == null || blml.size() < 1)
			return;

		int index = blml.indexOf(getSelectedBranche());

		/**
		 * Check, if all tabs with data binded components are created So we work
		 * with spring BeanCreation we must check a little bit deeper, because
		 * the Controller are preCreated ? After that, go back to the
		 * current/selected tab.
		 */
		Tab currentTab = tabbox_BranchMain.getSelectedTab();

		if (getBranchDetailCtrl().getBinder() == null) {
			Events.sendEvent(new Event(Events.ON_SELECT, tabBranchDetail, null));
		}

		// go back to selected tab
		currentTab.setSelected(true);

		// Check which button is clicked and calculate the rowIndex
		if (((ForwardEvent) event).getOrigin().getTarget() == btnNext) {
			if (index < (blml.size() - 1)) {
				index = index + 1;
			}
		} else if (((ForwardEvent) event).getOrigin().getTarget() == btnPrevious) {
			if (index > 0) {
				index = index - 1;
			}
		} else if (((ForwardEvent) event).getOrigin().getTarget() == btnFirst) {
			if (index != 0) {
				index = 0;
			}
		} else if (((ForwardEvent) event).getOrigin().getTarget() == btnLast) {
			if (index != blml.size()) {
				index = (blml.size() - 1);
			}
		}

		getBranchListCtrl().getListBoxBranch().setSelectedIndex(index);
		setSelectedBranche((Branche) blml.get(index));

		// call onSelect() for showing the objects data in the statusBar
		Events.sendEvent(new Event(Events.ON_SELECT, getBranchListCtrl().getListBoxBranch(), getSelectedBranche()));

		// refresh master-detail MASTERS data
		getBranchDetailCtrl().getBinder().loadAll();
	}

	// +++++++++++++++++++++++++++++++++++++++++++++++++ //
	// ++++++++++++++++++++ Helpers ++++++++++++++++++++ //
	// +++++++++++++++++++++++++++++++++++++++++++++++++ //

	/**
	 * Resizes the container from the selected Tab.
	 * 
	 * @param event
	 */
	private void doResizeSelectedTab(Event event) {
		// logger.debug(event.toString());

		if (this.tabbox_BranchMain.getSelectedTab() == this.tabBranchDetail) {
			getBranchDetailCtrl().doFitSize(event);
		} else if (this.tabbox_BranchMain.getSelectedTab() == this.tabBranchList) {
			// resize and fill Listbox new
			getBranchListCtrl().doFillListbox();
		}
	}

	/**
	 * Opens the help screen for the current module.
	 * 
	 * @param event
	 * @throws InterruptedException
	 */
	private void doHelp(Event event) throws InterruptedException {

		// Component comp = (Button) ((ForwardEvent)
		// event).getOrigin().getTarget();
		// HashMap<String, Object> map = new HashMap<String, Object>();
		// map.put("parentComponent", comp);
		// Executions.createComponents("/WEB-INF/pages/util/helpWindow.zul",
		// windowBranchMain, map);

		ZksampleMessageUtils.doShowNotImplementedMessage();

		// we stop the propagation of the event, because zk will call ALL events
		// with the same name in the namespace and 'btnHelp' is a standard
		// button in this application and can often appears.
		// Events.getRealOrigin((ForwardEvent) event).stopPropagation();
		event.stopPropagation();
	}

	/**
	 * Saves the selected object's current properties. We can get them back if a
	 * modification is canceled.
	 * 
	 * @see doResetToInitValues()
	 */
	public void doStoreInitValues() {

		if (getSelectedBranche() != null) {

			try {
				setOriginalBranche((Branche) ZksampleBeanUtils.cloneBean(getSelectedBranche()));
			} catch (final IllegalAccessException e) {
				throw new RuntimeException(e);
			} catch (final InstantiationException e) {
				throw new RuntimeException(e);
			} catch (final InvocationTargetException e) {
				throw new RuntimeException(e);
			} catch (final NoSuchMethodException e) {
				throw new RuntimeException(e);
			}
		}
	}

	/**
	 * Reset the selected object to its origin property values.
	 * 
	 * @see doStoreInitValues()
	 * 
	 */
	public void doResetToInitValues() {

		if (getOriginalBranche() != null) {

			try {
				setSelectedBranche((Branche) ZksampleBeanUtils.cloneBean(getOriginalBranche()));
				// TODO Bug in DataBinder??
				this.windowBranchMain.invalidate();

			} catch (final IllegalAccessException e) {
				throw new RuntimeException(e);
			} catch (final InstantiationException e) {
				throw new RuntimeException(e);
			} catch (final InvocationTargetException e) {
				throw new RuntimeException(e);
			} catch (final NoSuchMethodException e) {
				throw new RuntimeException(e);
			}
		}
	}

	/**
	 * User rights check. <br>
	 * Only components are set visible=true if the logged-in <br>
	 * user have the right for it. <br>
	 * 
	 * The rights are getting from the spring framework users
	 * grantedAuthority(). Remember! A right is only a string. <br>
	 */
	// TODO move it to the zul-file
	private void doCheckRights() {

		final UserWorkspace workspace = getUserWorkspace();

		this.button_BranchMain_Search_BranchName.setVisible(workspace.isAllowed("button_BranchMain_Search_BranchName"));

	}

	// +++++++++++++++++++++++++++++++++++++++++++++++++ //
	// ++++++++++++++++ Setter/Getter ++++++++++++++++++ //
	// +++++++++++++++++++++++++++++++++++++++++++++++++ //

	/* Master BEANS */
	public void setOriginalBranche(Branche originalBranche) {
		this.originalBranche = originalBranche;
	}

	public Branche getOriginalBranche() {
		return this.originalBranche;
	}

	public void setSelectedBranche(Branche selectedBranche) {
		this.selectedBranche = selectedBranche;
	}

	public Branche getSelectedBranche() {
		return this.selectedBranche;
	}

	public void setBranches(BindingListModelList branches) {
		this.branches = branches;
	}

	public BindingListModelList getBranches() {
		return this.branches;
	}

	/* CONTROLLERS */
	public void setBranchListCtrl(BranchListCtrl branchListCtrl) {
		this.branchListCtrl = branchListCtrl;
	}

	public BranchListCtrl getBranchListCtrl() {
		return this.branchListCtrl;
	}

	public void setBranchDetailCtrl(BranchDetailCtrl branchDetailCtrl) {
		this.branchDetailCtrl = branchDetailCtrl;
	}

	public BranchDetailCtrl getBranchDetailCtrl() {
		return this.branchDetailCtrl;
	}

	/* SERVICES */
	public BrancheService getBrancheService() {
		return this.brancheService;
	}

	public void setBrancheService(BrancheService brancheService) {
		this.brancheService = brancheService;
	}

	/* COMPONENTS and OTHERS */
}