01: /**
02: * Copyright 2006 Webmedia Group Ltd.
03: *
04: * Licensed under the Apache License, Version 2.0 (the "License");
05: * you may not use this file except in compliance with the License.
06: * You may obtain a copy of the License at
07: *
08: * http://www.apache.org/licenses/LICENSE-2.0
09: *
10: * Unless required by applicable law or agreed to in writing, software
11: * distributed under the License is distributed on an "AS IS" BASIS,
12: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13: * See the License for the specific language governing permissions and
14: * limitations under the License.
15: **/package org.araneaframework.http;
16:
17: import java.io.Serializable;
18:
19: /**
20: * Update region filter, supporting updating of HTML page regions and sending
21: * miscellaneous data back via AJAX requests.
22: *
23: * @author Alar Kvell (alar@araneaframework.org)
24: * @since 1.1
25: */
26: public interface UpdateRegionContext extends Serializable {
27: /**
28: * The request key for update regions that should be processed by this {@link UpdateRegionContext}.
29: */
30: public static final String UPDATE_REGIONS_KEY = "updateRegions";
31:
32: /**
33: * Disable updateregion filter during this request only. Already rendered data
34: * will be discarded. In client-side, transactionId will be set inconsistent
35: * and page will be forced to reload in order to perform full render.
36: */
37: void disableOnce();
38:
39: /**
40: * Adds the region which should be rendered and included in the current response.
41: * @param documentRegionId fully qualified update region id
42: */
43: void addRenderedRegion(String documentRegionId);
44:
45: /**
46: * Notify that a document region is rendered by the specified widget. The list
47: * of document regions is cleared before every full render. Updateregion tags
48: * should always call this, so that when updateregion filter is invoked, it is
49: * known which widget to render for a particular document region.
50: *
51: * @param documentRegionId document region id
52: * @param widgetId id of the widget that will render the document region
53: */
54: void addDocumentRegion(String documentRegionId, String widgetId);
55:
56: }
|