org.zkoss.zkmax.zul.Dropupload_6_5_2 Class Reference

Inheritance diagram for org.zkoss.zkmax.zul.Dropupload_6_5_2:

Collaboration diagram for org.zkoss.zkmax.zul.Dropupload_6_5_2:

Public Member Functions
	Dropupload_6_5_2 ()
void	setMaxsize (int value)
int	getMaxsize ()
void	setDetection (String value)
String	getDetection ()
void	setViewerClass (String value)
String	getViewerClass ()
void	setContent (String value)
String	getContent ()
void	setNative (boolean value)
boolean	isNative ()
void	service (AuRequest request, boolean everError)

Protected Member Functions
void	renderProperties (ContentRenderer renderer) throws java.io.IOException

Detailed Description

A component can handle drag files into it, and upload files to server.

Default getZclass(): z-dropupload.

known supported browser :

Chrome (v.19+) Firefox (v.13+) Safari (5.1+)

known unsupported browser :

IE9 Opera (11.x)

Since

6.5.0

Definition at line 50 of file Dropupload_6_5_2.java.

Constructor & Destructor Documentation

Dropupload_6_5_2()

org.zkoss.zkmax.zul.Dropupload_6_5_2.Dropupload_6_5_2

(

)

Definition at line 63 of file Dropupload_6_5_2.java.

{}

Member Function Documentation

getContent()

String org.zkoss.zkmax.zul.Dropupload_6_5_2.getContent

(

)

Returns

content of component.

Definition at line 154 of file Dropupload_6_5_2.java.

                               {
        return _content;
    }

getDetection()

String org.zkoss.zkmax.zul.Dropupload_6_5_2.getDetection

(

)

Return the detection area setting. Refer to setDetection(String) for more details.

Definition at line 113 of file Dropupload_6_5_2.java.

                                 {
        return _detection;
    }

getMaxsize()

int org.zkoss.zkmax.zul.Dropupload_6_5_2.getMaxsize

(

)

Get the max size setting of upload file, unit is "KB". Refer to setMaxsize(int) for more details.

Definition at line 86 of file Dropupload_6_5_2.java.

                            {
        return _maxsize;
    }

getViewerClass()

String org.zkoss.zkmax.zul.Dropupload_6_5_2.getViewerClass

(

)

Returns

custom upload viewer class name.

Definition at line 135 of file Dropupload_6_5_2.java.

                                   {
        return _viewerClass;
    }

isNative()

boolean org.zkoss.zkmax.zul.Dropupload_6_5_2.isNative

(

)

Definition at line 165 of file Dropupload_6_5_2.java.

                              {
        return _native;
    }

renderProperties()

void org.zkoss.zkmax.zul.Dropupload_6_5_2.renderProperties ( ContentRenderer  renderer ) throws java.io.IOException

protected

Definition at line 170 of file Dropupload_6_5_2.java.

                                       {
        if (_maxsize == 0) { // not assign maxsize, get the default setting.
            _maxsize = this.getDesktop().getWebApp().getConfiguration().getMaxUploadSize();
        }
        
        super.renderProperties(renderer);
        if (!Objects.equals(_detection, DEFAULT_DETECTION)) { 
            render(renderer, "detection", _detection);
        }
        render(renderer, "maxsize", _maxsize);
        render(renderer, "viewerClass", _viewerClass);
        render(renderer, "content", _content);
        render(renderer, "native", _native);
    }

service()

void org.zkoss.zkmax.zul.Dropupload_6_5_2.service	(	AuRequest	request,
		boolean	everError
	)

Process an AU request. It will handle Events#ON_UPLOAD and post UploadEvent.

See also

org.zkoss.zk.ui.HtmlBasedComponent::service(org.zkoss.zk.au.AuRequest, boolean)

Definition at line 191 of file Dropupload_6_5_2.java.

                                                              {
        final String cmd = request.getCommand();
        if (Events.ON_UPLOAD.equals(cmd)) {
            Desktop desktop = getDesktop();
            final List<Media> result = cast((List) desktop.getAttribute(this.getUuid()));
            desktop.removeAttribute(this.getUuid());
            Event event = new UploadEvent(
                Events.ON_UPLOAD, 
                desktop.getComponentByUuid(this.getUuid()), parseResult(result)
            );
            Events.postEvent(event);
        } else {
            super.service(request, everError);
        }
    }

setContent()

void org.zkoss.zkmax.zul.Dropupload_6_5_2.setContent

(

String

value

)

Set the content of component, it will be shown depend on detection setting.

See also

setDetection(String)

Parameters

value

HTML string.

Definition at line 144 of file Dropupload_6_5_2.java.

                                         {
        if (value != null && !value.equals(_content)) {
            _content = value;
            smartUpdate("content", _content);
        }
    }

setDetection()

void org.zkoss.zkmax.zul.Dropupload_6_5_2.setDetection

(

String

value

)

Set drag detection area. When mouse drag over the detection area, it will show content. There are four accept value :

1. browser : whole browser, default value.
2. none : disable detection.
3. self : the Dropupload_6_5_2 itself.
4. $id : the id value of specified widget. If specified widget is not exist, will use default setting.

Notice : The Dropupload_6_5_2 with detection="browser" setting can't put together with other Dropupload_6_5_2 that detection is not browser. If do so, the user can't drop file on it.

Parameters

value

Definition at line 103 of file Dropupload_6_5_2.java.

                                           {
        if (!_detection.equals(value)) {
            _detection = value;
            smartUpdate("detection", _detection);
        }
    }

setMaxsize()

void org.zkoss.zkmax.zul.Dropupload_6_5_2.setMaxsize

(

int

value

)

Set the max size of upload file, unit is "KB". Notice: All the files in one drag-and-drop action must smaller than max size, or nothing will upload.

Parameters

value

negative value is unlimited, 0 will use Configuration#getMaxUploadSize()

Definition at line 71 of file Dropupload_6_5_2.java.

                                      {
        if (value < 0) {
            value = -1;
        }
 
        if (_maxsize != value) {
            _maxsize = value;
            smartUpdate("maxsize", _maxsize);
        }
    }

setNative()

void org.zkoss.zkmax.zul.Dropupload_6_5_2.setNative

(

boolean

value

)

Definition at line 158 of file Dropupload_6_5_2.java.

                                         {
        if (value != _native) {
            _native = value;
            smartUpdate("native", _native);
        }
    }

setViewerClass()

void org.zkoss.zkmax.zul.Dropupload_6_5_2.setViewerClass

(

String

value

)

Set the custom upload viewer class name, if was not specified, will use ZK default upload viewer.

Parameters

value

custom upload viewer class name.

Definition at line 121 of file Dropupload_6_5_2.java.

                                             {
        if (value != null && value.length() == 0) {
            value = null;
        }
 
        if (!Objects.equals(_viewerClass, value)) {
            _viewerClass = value;
            smartUpdate("viewerClass", _viewerClass);
        }
    }

---

The documentation for this class was generated from the following file:

• Dropupload_6_5_2.java