JOGL v2.6.0-rc-20250712
JOGL, High-Performance Graphics Binding for Java™ (public API).
Widget.java
Go to the documentation of this file.
1/**
2 * Copyright 2010-2023 JogAmp Community. All rights reserved.
3 *
4 * Redistribution and use in source and binary forms, with or without modification, are
5 * permitted provided that the following conditions are met:
6 *
7 * 1. Redistributions of source code must retain the above copyright notice, this list of
8 * conditions and the following disclaimer.
9 *
10 * 2. Redistributions in binary form must reproduce the above copyright notice, this list
11 * of conditions and the following disclaimer in the documentation and/or other materials
12 * provided with the distribution.
13 *
14 * THIS SOFTWARE IS PROVIDED BY JogAmp Community ``AS IS'' AND ANY EXPRESS OR IMPLIED
15 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
16 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL JogAmp Community OR
17 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
19 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
20 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
21 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
22 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
23 *
24 * The views and conclusions contained in the software and documentation are those of the
25 * authors and should not be interpreted as representing official policies, either expressed
26 * or implied, of JogAmp Community.
27 */
28package com.jogamp.graph.ui.widgets;
29
30import com.jogamp.graph.ui.Group;
31import com.jogamp.graph.ui.Shape;
32import com.jogamp.graph.ui.Group.Layout;
33
34/**
35 * A widget specifies specific UI semantics including individual controls.
36 * <p>
37 * Being a {@link Group}, implementations provide shape(s) and its instance can be added to the user's scene.
38 * </p>
39 * <p>
40 * Due to the specific nature of widgets,
41 * individual controls/listener may be provided with semantic values.
42 * </p>
43 */
44public class Widget extends Group {
45 /**
46 * Create a Widget group of {@link Shape}s w/o {@link Group.Layout}.
47 * <p>
48 * Default is non-interactive, see {@link #setInteractive(boolean)}.
49 * </p>
50 */
51 public Widget() {
52 super(null);
53 }
54
55 /**
56 * Create a Widget group of {@link Shape}s w/ given {@link Group.Layout}.
57 * <p>
58 * Default is non-interactive, see {@link #setInteractive(boolean)}.
59 * </p>
60 * @param l optional {@link Layout}, maybe {@code null}
61 */
62 public Widget(final Layout l) {
63 super(l);
64 }
65}
Group of Shapes, optionally utilizing a Group.Layout.
Definition: Group.java:61
A widget specifies specific UI semantics including individual controls.
Definition: Widget.java:44
Widget()
Create a Widget group of Shapes w/o Group.Layout.
Definition: Widget.java:51
Widget(final Layout l)
Create a Widget group of Shapes w/ given Group.Layout.
Definition: Widget.java:62
Layout for the GraphUI Group, called @ Shape#validate(GL2ES2) or Shape#validate(GLProfile).
Definition: Group.java:63