org.opencms.gwt.client.ui.input.CmsGroupSelection Maven / Gradle / Ivy
Show all versions of opencms-gwt Show documentation
/*
* This library is part of OpenCms -
* the Open Source Content Management System
*
* Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* For further information about Alkacon Software, please see the
* company website: http://www.alkacon.com
*
* For further information about OpenCms, please see the
* project website: http://www.opencms.org
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
package org.opencms.gwt.client.ui.input;
import org.opencms.gwt.client.CmsCoreProvider;
import org.opencms.gwt.client.I_CmsHasInit;
import org.opencms.gwt.client.ui.CmsPushButton;
import org.opencms.gwt.client.ui.I_CmsAutoHider;
import org.opencms.gwt.client.ui.input.form.CmsWidgetFactoryRegistry;
import org.opencms.gwt.client.ui.input.form.I_CmsFormWidgetFactory;
import java.util.Map;
import com.google.gwt.event.dom.client.BlurEvent;
import com.google.gwt.event.dom.client.BlurHandler;
import com.google.gwt.event.logical.shared.HasValueChangeHandlers;
import com.google.gwt.event.logical.shared.ValueChangeHandler;
import com.google.gwt.event.shared.HandlerRegistration;
import com.google.gwt.user.client.Command;
import com.google.gwt.user.client.DOM;
import com.google.gwt.user.client.Event;
import com.google.gwt.user.client.Event.NativePreviewEvent;
import com.google.gwt.user.client.Event.NativePreviewHandler;
import com.google.gwt.user.client.ui.Composite;
import com.google.gwt.user.client.ui.FlowPanel;
import com.google.gwt.user.client.ui.Panel;
import com.google.gwt.user.client.ui.SimplePanel;
import com.google.gwt.user.client.ui.TextBox;
/**
* Basic group selection.
*
* @since 8.0.0
*
*/
public class CmsGroupSelection extends Composite
implements I_CmsFormWidget, I_CmsHasInit, HasValueChangeHandlers {
/**
* Event preview handler.
*
* To be used while popup open.
*/
protected class CloseEventPreviewHandler implements NativePreviewHandler {
/**
* @see com.google.gwt.user.client.Event.NativePreviewHandler#onPreviewNativeEvent(com.google.gwt.user.client.Event.NativePreviewEvent)
*/
public void onPreviewNativeEvent(NativePreviewEvent event) {
Event nativeEvent = Event.as(event.getNativeEvent());
switch (DOM.eventGetType(nativeEvent)) {
case Event.ONMOUSEMOVE:
break;
case Event.ONMOUSEUP:
break;
case Event.ONMOUSEDOWN:
break;
case Event.ONKEYUP:
openNative(buildGalleryUrl(), m_title);
break;
case Event.ONMOUSEWHEEL:
break;
default:
// do nothing
}
}
}
/** A counter used for giving text box widgets ids. */
private static int idCounter;
/** The widget type identifier for this widget. */
private static final String WIDGET_TYPE = "groupselection";
/** The fade panel. */
protected Panel m_fadePanel = new SimplePanel();
/** The old value. */
protected String m_oldValue = "";
/** The handler registration. */
protected HandlerRegistration m_previewHandlerRegistration;
/** The popup title. */
protected String m_title = org.opencms.gwt.client.Messages.get().key(
org.opencms.gwt.client.Messages.GUI_GALLERY_SELECT_DIALOG_TITLE_0);
/** The default rows set. */
int m_defaultRows;
/** The root panel containing the other components of this widget. */
Panel m_panel = new FlowPanel();
/** The container for the text area. */
CmsSelectionInput m_selectionInput;
/** The internal text area widget used by this widget. */
TextBox m_textBox;
/** The container for the text area. */
FlowPanel m_textBoxContainer = new FlowPanel();
/** The error display for this widget. */
private CmsErrorWidget m_error = new CmsErrorWidget();
/** The flag parameter. */
private Integer m_flags;
/** The id for the windows. */
private String m_id;
/** The button to to open the selection. */
private CmsPushButton m_openSelection;
/** The ou parameter. */
private String m_ouFqn;
/** The user parameter. */
private String m_userName;
/**
* Constructor.
*
* @param iconImage the image of the icon shown in the
*/
public CmsGroupSelection(String iconImage) {
initWidget(m_panel);
m_selectionInput = new CmsSelectionInput(iconImage);
m_id = "CmsGroupSelection_" + (idCounter++);
m_selectionInput.m_textbox.getElement().setId(m_id);
m_panel.add(m_selectionInput);
m_panel.add(m_error);
m_selectionInput.m_textbox.addBlurHandler(new BlurHandler() {
public void onBlur(BlurEvent event) {
if ((m_selectionInput.m_textbox.getValue().length()
* 6.88) > m_selectionInput.m_textbox.getOffsetWidth()) {
setTitle(m_selectionInput.m_textbox.getValue());
}
m_selectionInput.showFader();
}
});
m_selectionInput.setOpenCommand(new Command() {
public void execute() {
setTitle("");
openNative(buildGalleryUrl(), m_title);
}
});
}
/**
* Initializes this class.
*/
public static void initClass() {
// registers a factory for creating new instances of this widget
CmsWidgetFactoryRegistry.instance().registerFactory(WIDGET_TYPE, new I_CmsFormWidgetFactory() {
/**
* @see org.opencms.gwt.client.ui.input.form.I_CmsFormWidgetFactory#createWidget(java.util.Map)
*/
public I_CmsFormWidget createWidget(Map widgetParams) {
return new CmsGroupSelection(null);
}
});
}
/**
* @see com.google.gwt.event.logical.shared.HasValueChangeHandlers#addValueChangeHandler(com.google.gwt.event.logical.shared.ValueChangeHandler)
*/
public HandlerRegistration addValueChangeHandler(ValueChangeHandler handler) {
return m_selectionInput.m_textbox.addValueChangeHandler(handler);
}
/**
* @see org.opencms.gwt.client.ui.input.I_CmsFormWidget#getApparentValue()
*/
public String getApparentValue() {
return getFormValueAsString();
}
/**
* @see org.opencms.gwt.client.ui.input.I_CmsFormWidget#getFieldType()
*/
public FieldType getFieldType() {
return I_CmsFormWidget.FieldType.STRING;
}
/**
* @see org.opencms.gwt.client.ui.input.I_CmsFormWidget#getFormValue()
*/
public Object getFormValue() {
if (m_selectionInput.m_textbox.getText() == null) {
return "";
}
return m_selectionInput.m_textbox.getValue();
}
/**
* @see org.opencms.gwt.client.ui.input.I_CmsFormWidget#getFormValueAsString()
*/
public String getFormValueAsString() {
return (String)getFormValue();
}
/**
* Returns the text contained in the text area.
*
* @return the text in the text area
*/
public String getText() {
return getFormValueAsString();
}
/**
* Returns the text box container of this widget.
*
* @return the text box container
*/
public CmsSelectionInput getTextAreaContainer() {
return m_selectionInput;
}
/**
* @see org.opencms.gwt.client.ui.input.I_CmsFormWidget#isEnabled()
*/
public boolean isEnabled() {
return m_selectionInput.m_textbox.isEnabled();
}
/**
* @see org.opencms.gwt.client.ui.input.I_CmsFormWidget#reset()
*/
public void reset() {
m_selectionInput.m_textbox.setText("");
}
/**
* @see org.opencms.gwt.client.ui.input.I_CmsFormWidget#setAutoHideParent(org.opencms.gwt.client.ui.I_CmsAutoHider)
*/
public void setAutoHideParent(I_CmsAutoHider autoHideParent) {
// nothing to do
}
/**
* @see org.opencms.gwt.client.ui.input.I_CmsFormWidget#setEnabled(boolean)
*/
public void setEnabled(boolean enabled) {
m_selectionInput.m_textbox.setEnabled(enabled);
}
/**
* @see org.opencms.gwt.client.ui.input.I_CmsFormWidget#setErrorMessage(java.lang.String)
*/
public void setErrorMessage(String errorMessage) {
m_error.setText(errorMessage);
}
/**
* Sets the value of the widget.
*
* @param value the new value
*/
public void setFormValue(Object value) {
if (value == null) {
value = "";
}
if (value instanceof String) {
String strValue = (String)value;
m_selectionInput.m_textbox.setText(strValue);
setTitle(strValue);
}
}
/**
* @see org.opencms.gwt.client.ui.input.I_CmsFormWidget#setFormValueAsString(java.lang.String)
*/
public void setFormValueAsString(String newValue) {
setFormValue(newValue);
}
/**
* Sets the name of the input field.
*
* @param name of the input field
* */
public void setName(String name) {
m_selectionInput.m_textbox.setName(name);
}
/**
* Sets the parameters for the popup.
*
* @param flags the flaq parameter
* @param ouFqn the ouFqn parameter
* @param userName the user Name parameter
*
* */
public void setParameter(Integer flags, String ouFqn, String userName) {
m_flags = flags;
m_ouFqn = ouFqn;
m_userName = userName;
}
/**
* Sets the text in the text area.
*
* @param text the new text
*/
public void setText(String text) {
setFormValueAsString(text);
}
/**
* @see com.google.gwt.user.client.ui.UIObject#setTitle(java.lang.String)
*/
@Override
public void setTitle(String title) {
m_selectionInput.m_textbox.getElement().setTitle(title);
}
/**
* Creates the URL for the gallery dialog IFrame.
*
* @return the URL for the gallery dialog IFrame
*/
protected String buildGalleryUrl() {
String basePath = "";
basePath = "/system/workplace/commons/group_selection.jsp?type=groupwidget&fieldid=" + m_id;
if (m_flags != null) {
basePath += "&flags=" + m_flags;
}
if (m_userName != null) {
basePath += "&user=" + m_userName;
}
if (m_ouFqn != null) {
basePath += "&oufqn=" + m_ouFqn;
}
return CmsCoreProvider.get().link(basePath);
}
/**
* Opens the Group selection.
*
* @param url the url of the popup
* @param title the title of the popup
* */
native void openNative(String url, String title) /*-{
$wnd
.open(
url,
title,
'toolbar=no,location=no,directories=no,status=yes,menubar=0,scrollbars=yes,resizable=yes,top=150,left=260,width=650,height=450');
var self = this;
$wnd.setGroupFormValue = function(value) {
[email protected]::setValueFromNative(Ljava/lang/String;)(value);
};
}-*/;
/**
* Sets the widget value and fires the change event if necessary.
*
* @param value the value to set
*/
private void setValueFromNative(String value) {
m_selectionInput.m_textbox.setValue(value, true);
}
}