Package: LayoutHelper

LayoutHelper

Coverage

1: /*******************************************************************************
2: * Copyright (c) 2011-2013 EclipseSource Muenchen GmbH and others.
3: *
4: * All rights reserved. This program and the accompanying materials
5: * are made available under the terms of the Eclipse Public License 2.0
6: * which accompanies this distribution, and is available at
7: * https://www.eclipse.org/legal/epl-2.0/
8: *
9: * SPDX-License-Identifier: EPL-2.0
10: *
11: * Contributors:
12: * Eugen Neufeld - initial API and implementation
13: ******************************************************************************/
14: package org.eclipse.emf.ecp.view.spi.renderer;
15:
16: /**
17: * By providing an own implementation, the layout of the application can be influenced.
18: *
19: * @author Eugen Neufeld
20: * @param <LAYOUT> the type of layout object this helper provides.
21: * @since 1.2
22: */
23: @Deprecated
24: public interface LayoutHelper<LAYOUT> {
25:
26:         /**
27:          * The Layout for aligning controls vertically in columns.
28:          *
29:          * @param numColumns the number of columns to create
30:          * @param equalWidth whether the columns should be equal width
31:          * @return the layout to use
32:          */
33:         LAYOUT getColumnLayout(int numColumns, boolean equalWidth);
34:
35:         /**
36:          * The Layout data to use to set a spanning on an element.
37:          *
38:          * @param xSpan the horizontal span
39:          * @param ySpan the vertical span
40:          * @return the layout data to set
41:          */
42:         Object getSpanningLayoutData(int xSpan, int ySpan);
43:
44:         /**
45:          * The Layout data to use to set for a left column.
46:          *
47:          * @return the layout data to set
48:          */
49:         Object getLeftColumnLayoutData();
50:
51:         /**
52:          * The Layout data to use to set for a right column.
53:          *
54:          * @param xSpan the horizontal span
55:          * @return the layout data to set
56:          */
57:         Object getRightColumnLayoutData(int xSpan);
58:
59:         /**
60:          * The Layout data to use to set for a validation column.
61:          *
62:          * @return the layout data to set
63:          */
64:         Object getValidationColumnLayoutData();
65:
66: }