org.primefaces.component.socket.Socket Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of primefaces Show documentation
There is a newer version: 14.0.0-RC3
/*
 * Generated, Do Not Modify
 */
/*
 * Copyright 2009-2013 PrimeTek.
 *
 * 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 org.primefaces.component.socket;

import javax.faces.component.UIComponentBase;
import javax.faces.context.FacesContext;
import javax.faces.component.UINamingContainer;
import javax.el.ValueExpression;
import javax.el.MethodExpression;
import javax.faces.render.Renderer;
import java.io.IOException;
import javax.faces.component.UIComponent;
import javax.faces.event.AbortProcessingException;
import javax.faces.application.ResourceDependencies;
import javax.faces.application.ResourceDependency;
import java.util.List;
import java.util.ArrayList;
import org.primefaces.util.ComponentUtils;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import org.primefaces.event.RateEvent;
import org.primefaces.util.Constants;
import javax.faces.event.AjaxBehaviorEvent;
import javax.faces.event.FacesEvent;
import java.util.Iterator;
import java.util.Map;
import java.util.HashMap;
import javax.faces.event.PhaseId;
import javax.faces.event.BehaviorEvent;

@ResourceDependencies({
	@ResourceDependency(library="primefaces", name="jquery/jquery.js"),
	@ResourceDependency(library="primefaces", name="core.js"),
	@ResourceDependency(library="primefaces", name="push/push.js")
})
public class Socket extends UIComponentBase implements org.primefaces.component.api.Widget,javax.faces.component.behavior.ClientBehaviorHolder,org.primefaces.component.api.PrimeClientBehaviorHolder {


	public static final String COMPONENT_TYPE = "org.primefaces.component.Socket";
	public static final String COMPONENT_FAMILY = "org.primefaces.component";
	public static final String DEFAULT_RENDERER = "org.primefaces.component.SocketRenderer";

	public enum PropertyKeys {

		widgetVar
		,channel
		,transport
		,fallbackTransport
		,onMessage
		,onError
		,onClose
		,onOpen
		,onReconnect
		,onMessagePublished
		,onTransportFailure
		,onLocalMessage
		,autoConnect;

		String toString;

		PropertyKeys(String toString) {
			this.toString = toString;
		}

		PropertyKeys() {}

		public String toString() {
			return ((this.toString != null) ? this.toString : super.toString());
}
	}

	public Socket() {
		setRendererType(DEFAULT_RENDERER);
	}

	public String getFamily() {
		return COMPONENT_FAMILY;
	}

	public java.lang.String getWidgetVar() {
		return (java.lang.String) getStateHelper().eval(PropertyKeys.widgetVar, null);
	}
	public void setWidgetVar(java.lang.String _widgetVar) {
		getStateHelper().put(PropertyKeys.widgetVar, _widgetVar);
	}

	public java.lang.String getChannel() {
		return (java.lang.String) getStateHelper().eval(PropertyKeys.channel, null);
	}
	public void setChannel(java.lang.String _channel) {
		getStateHelper().put(PropertyKeys.channel, _channel);
	}

	public java.lang.String getTransport() {
		return (java.lang.String) getStateHelper().eval(PropertyKeys.transport, "websocket");
	}
	public void setTransport(java.lang.String _transport) {
		getStateHelper().put(PropertyKeys.transport, _transport);
	}

	public java.lang.String getFallbackTransport() {
		return (java.lang.String) getStateHelper().eval(PropertyKeys.fallbackTransport, "long-polling");
	}
	public void setFallbackTransport(java.lang.String _fallbackTransport) {
		getStateHelper().put(PropertyKeys.fallbackTransport, _fallbackTransport);
	}

	public java.lang.String getOnMessage() {
		return (java.lang.String) getStateHelper().eval(PropertyKeys.onMessage, null);
	}
	public void setOnMessage(java.lang.String _onMessage) {
		getStateHelper().put(PropertyKeys.onMessage, _onMessage);
	}

	public java.lang.String getOnError() {
		return (java.lang.String) getStateHelper().eval(PropertyKeys.onError, null);
	}
	public void setOnError(java.lang.String _onError) {
		getStateHelper().put(PropertyKeys.onError, _onError);
	}

	public java.lang.String getOnClose() {
		return (java.lang.String) getStateHelper().eval(PropertyKeys.onClose, null);
	}
	public void setOnClose(java.lang.String _onClose) {
		getStateHelper().put(PropertyKeys.onClose, _onClose);
	}

	public java.lang.String getOnOpen() {
		return (java.lang.String) getStateHelper().eval(PropertyKeys.onOpen, null);
	}
	public void setOnOpen(java.lang.String _onOpen) {
		getStateHelper().put(PropertyKeys.onOpen, _onOpen);
	}

	public java.lang.String getOnReconnect() {
		return (java.lang.String) getStateHelper().eval(PropertyKeys.onReconnect, null);
	}
	public void setOnReconnect(java.lang.String _onReconnect) {
		getStateHelper().put(PropertyKeys.onReconnect, _onReconnect);
	}

	public java.lang.String getOnMessagePublished() {
		return (java.lang.String) getStateHelper().eval(PropertyKeys.onMessagePublished, null);
	}
	public void setOnMessagePublished(java.lang.String _onMessagePublished) {
		getStateHelper().put(PropertyKeys.onMessagePublished, _onMessagePublished);
	}

	public java.lang.String getOnTransportFailure() {
		return (java.lang.String) getStateHelper().eval(PropertyKeys.onTransportFailure, null);
	}
	public void setOnTransportFailure(java.lang.String _onTransportFailure) {
		getStateHelper().put(PropertyKeys.onTransportFailure, _onTransportFailure);
	}

	public java.lang.String getOnLocalMessage() {
		return (java.lang.String) getStateHelper().eval(PropertyKeys.onLocalMessage, null);
	}
	public void setOnLocalMessage(java.lang.String _onLocalMessage) {
		getStateHelper().put(PropertyKeys.onLocalMessage, _onLocalMessage);
	}

	public boolean isAutoConnect() {
		return (java.lang.Boolean) getStateHelper().eval(PropertyKeys.autoConnect, true);
	}
	public void setAutoConnect(boolean _autoConnect) {
		getStateHelper().put(PropertyKeys.autoConnect, _autoConnect);
	}


    private final static String DEFAULT_EVENT = "message";

    private static final Map> BEHAVIOR_EVENT_MAPPING = Collections.unmodifiableMap(new HashMap>() {{
        put("message", null);
    }});

    private static final Collection EVENT_NAMES = BEHAVIOR_EVENT_MAPPING.keySet();

    @Override
    public Map> getBehaviorEventMapping() {
         return BEHAVIOR_EVENT_MAPPING;
    }

    @Override
    public Collection getEventNames() {
        return EVENT_NAMES;
    }

    @Override
    public String getDefaultEventName() {
        return DEFAULT_EVENT;
    }
	public String resolveWidgetVar() {
		return ComponentUtils.resolveWidgetVar(getFacesContext(), this);
	}
}