01: /*
02: * Licensed to the Apache Software Foundation (ASF) under one or more
03: * contributor license agreements. See the NOTICE file distributed with
04: * this work for additional information regarding copyright ownership.
05: * The ASF licenses this file to You under the Apache License, Version 2.0
06: * (the "License"); you may not use this file except in compliance with
07: * the License. You may obtain a copy of the License at
08: *
09: * http://www.apache.org/licenses/LICENSE-2.0
10: *
11: * Unless required by applicable law or agreed to in writing, software
12: * distributed under the License is distributed on an "AS IS" BASIS,
13: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14: * See the License for the specific language governing permissions and
15: * limitations under the License.
16: */
17: package org.apache.wicket.extensions.markup.html.repeater.data.table;
18:
19: import org.apache.wicket.Component;
20: import org.apache.wicket.extensions.markup.html.repeater.data.grid.ICellPopulator;
21:
22: /**
23: * An inteface that represents a column in the {@link DefaultDataTable}
24: *
25: * @author Igor Vaynberg ( ivaynberg )
26: */
27: public interface IColumn extends ICellPopulator {
28: /**
29: * Returns the component that will be used as the header for the column.
30: *
31: * This component will be contained in <span> tags.
32: *
33: * @param componentId
34: * component id for the returned Component
35: *
36: * @return component that will be used as the header for the column
37: */
38: Component getHeader(String componentId);
39:
40: /**
41: * Returns the name of the property that this header sorts. If null is
42: * returned the header will be unsortable.
43: *
44: * @return a string representing the sort property
45: */
46: String getSortProperty();
47:
48: /**
49: * Returns true if this header should be a sortable header
50: *
51: * @return true if header should be sortable
52: */
53: boolean isSortable();
54: }
|