Skip to content

Commit

Permalink
Bug 729, Bug 849: Honor JAWTWindow's [parent] visibility state
Browse files Browse the repository at this point in the history 
JAWTWindow snoops HierarchyEvents for SHOWING_CHANGED to
track local component's visibility state as well as it's global visibility state.
The later is determined by it's parent's visibility change.

If 'removeNotify()' is called, component's visibility is reset to it's local visibility state.

Fixes OSX CALayer component's visibility if parent's visibility changes (Bug 729).

Fixes continuous GL rendering if parent is invisible (Bug 849).
  • Loading branch information
@sgothel
sgothel committed Oct 6, 2013
1 parent 1259693 commit e33e637
Show file tree
Hide file tree
Showing 5 changed files with 457 additions and 31 deletions.
4 changes: 3 additions & 1 deletion make/scripts/tests.sh
View file
Expand Up @@ -456,7 +456,9 @@ function testawtswt() {
#testawt com.jogamp.opengl.test.junit.jogl.acore.x11.TestGLXCallsOnAWT $*
#testawt com.jogamp.opengl.test.junit.jogl.awt.TestBug816OSXCALayerPos01AWT $*
#testawt com.jogamp.opengl.test.junit.jogl.awt.TestBug816OSXCALayerPos02AWT $*
testawt com.jogamp.opengl.test.junit.jogl.awt.TestBug816OSXCALayerPos03AWT $*
#testawt com.jogamp.opengl.test.junit.jogl.awt.TestBug816OSXCALayerPos03aAWT $*
testawt com.jogamp.opengl.test.junit.jogl.awt.TestBug816OSXCALayerPos03bAWT $*
#testawt com.jogamp.opengl.test.junit.jogl.awt.TestBug816OSXCALayerPos03cAWT $*
#testawt com.jogamp.opengl.test.junit.jogl.awt.TestBug816OSXCALayerPos04aAWT $*
#testawt com.jogamp.opengl.test.junit.jogl.awt.TestBug816OSXCALayerPos04bAWT $*
#testawt com.jogamp.opengl.test.junit.jogl.awt.TestBug675BeansInDesignTimeAWT $*
Expand Down
122 changes: 96 additions & 26 deletions src/nativewindow/classes/com/jogamp/nativewindow/awt/JAWTWindow.java
View file
Expand Up @@ -37,6 +37,7 @@

package com.jogamp.nativewindow.awt;

import com.jogamp.common.os.Platform;
import com.jogamp.common.util.locks.LockFactory;
import com.jogamp.common.util.locks.RecursiveLock;
import com.jogamp.nativewindow.MutableGraphicsConfiguration;
Expand All @@ -46,6 +47,8 @@
import java.awt.Window;
import java.awt.event.ComponentEvent;
import java.awt.event.ComponentListener;
import java.awt.event.HierarchyEvent;
import java.awt.event.HierarchyListener;
import java.applet.Applet;

import javax.media.nativewindow.AbstractGraphicsConfiguration;
Expand Down Expand Up @@ -76,10 +79,11 @@ public abstract class JAWTWindow implements NativeWindow, OffscreenLayerSurface,
protected boolean shallUseOffscreenLayer = false;

// lifetime: forever
protected Component component;
private AWTGraphicsConfiguration config; // control access due to delegation
private SurfaceUpdatedHelper surfaceUpdatedHelper = new SurfaceUpdatedHelper();
private RecursiveLock surfaceLock = LockFactory.createRecursiveLock();
protected final Component component;
private final AWTGraphicsConfiguration config; // control access due to delegation
private final SurfaceUpdatedHelper surfaceUpdatedHelper = new SurfaceUpdatedHelper();
private final RecursiveLock surfaceLock = LockFactory.createRecursiveLock();
private final JAWTComponentListener jawtComponentListener;

// lifetime: valid after lock but may change with each 1st lock, purges after invalidate
private boolean isApplet;
Expand All @@ -106,39 +110,110 @@ protected JAWTWindow(Object comp, AbstractGraphicsConfiguration config) {
if(! ( config instanceof AWTGraphicsConfiguration ) ) {
throw new NativeWindowException("Error: AbstractGraphicsConfiguration is not an AWTGraphicsConfiguration: "+config);
}
this.component = (Component)comp;
this.config = (AWTGraphicsConfiguration) config;
init((Component)comp);
}

private void init(Component windowObject) throws NativeWindowException {
this.jawtComponentListener = new JAWTComponentListener();
this.component.addComponentListener(jawtComponentListener);
this.component.addHierarchyListener(jawtComponentListener);
invalidate();
this.component = windowObject;
this.isApplet = false;
this.offscreenSurfaceLayer = 0;
this.component.addComponentListener(new ComponentListener() {
private boolean visible = component.isVisible();
}
private class JAWTComponentListener implements ComponentListener, HierarchyListener {
private boolean localVisibility = component.isVisible();
private boolean globalVisibility = localVisibility;
private boolean visibilityPropagation = false;

private String s(ComponentEvent e) {
return "visible[local "+localVisibility+", global "+globalVisibility+", propag. "+visibilityPropagation+"],"+Platform.getNewline()+
" ** COMP "+e.getComponent()+Platform.getNewline()+
" ** SOURCE "+e.getSource()+Platform.getNewline()+
" ** THIS "+component;
}
private String s(HierarchyEvent e) {
return "visible[local "+localVisibility+", global "+globalVisibility+", propag. "+visibilityPropagation+"], changeBits 0x"+Long.toHexString(e.getChangeFlags())+Platform.getNewline()+
" ** COMP "+e.getComponent()+Platform.getNewline()+
" ** SOURCE "+e.getSource()+Platform.getNewline()+
" ** CHANGED "+e.getChanged()+Platform.getNewline()+
" ** CHANGEDPARENT "+e.getChangedParent()+Platform.getNewline()+
" ** THIS "+component;
}

@Override
public void componentResized(ComponentEvent e) {
layoutSurfaceLayerIfEnabled(visible);
if(DEBUG) {
System.err.println("JAWTWindow.componentResized: "+s(e));
}
layoutSurfaceLayerIfEnabled(globalVisibility && localVisibility);
}

@Override
public void componentMoved(ComponentEvent e) {
layoutSurfaceLayerIfEnabled(visible);
if(DEBUG) {
System.err.println("JAWTWindow.componentMoved: "+s(e));
}
layoutSurfaceLayerIfEnabled(globalVisibility && localVisibility);
}

@Override
public void componentShown(ComponentEvent e) {
visible = true;
layoutSurfaceLayerIfEnabled(visible);
if(DEBUG) {
System.err.println("JAWTWindow.componentShown: "+s(e));
}
layoutSurfaceLayerIfEnabled(globalVisibility && localVisibility);
}

@Override
public void componentHidden(ComponentEvent e) {
visible = false;
layoutSurfaceLayerIfEnabled(visible);
}
});
if(DEBUG) {
System.err.println("JAWTWindow.componentHidden: "+s(e));
}
layoutSurfaceLayerIfEnabled(globalVisibility && localVisibility);
}

@Override
public void hierarchyChanged(HierarchyEvent e) {
final long bits = e.getChangeFlags();
final java.awt.Component changed = e.getChanged();
if( 0 != ( java.awt.event.HierarchyEvent.DISPLAYABILITY_CHANGED & bits ) ) {
final boolean displayable = changed.isDisplayable();
final boolean resetLocalVisibility = changed == component && !displayable && localVisibility != component.isVisible();
if( resetLocalVisibility ) {
// Reset components local state if detached from parent, i.e. 'removeNotify()'
visibilityPropagation = true;
if(DEBUG) {
System.err.println("JAWTWindow.hierarchyChanged DISPLAYABILITY_CHANGED (1): displayable "+displayable+", "+s(e));
}
component.setVisible(localVisibility);
} else if(DEBUG) {
System.err.println("JAWTWindow.hierarchyChanged DISPLAYABILITY_CHANGED (x): displayable "+displayable+", "+s(e));
}
} else if( 0 != ( java.awt.event.HierarchyEvent.SHOWING_CHANGED & bits ) ) {
final boolean showing = changed.isShowing();
final boolean propagateVisibility = changed != component && ( showing && localVisibility ) != component.isVisible();
if( propagateVisibility ) {
// Propagate parent's visibility
final boolean _visible = showing && localVisibility;
visibilityPropagation = true;
globalVisibility = showing;
if(DEBUG) {
System.err.println("JAWTWindow.hierarchyChanged SHOWING_CHANGED (1): showing "+showing+" -> visible "+_visible+", "+s(e));
}
component.setVisible(_visible);
} else if( changed == component ) {
// Update component's local visibility state
if(!visibilityPropagation) {
localVisibility = showing;
}
visibilityPropagation = false;
if(DEBUG) {
System.err.println("JAWTWindow.hierarchyChanged SHOWING_CHANGED (0): showing "+showing+" -> visible "+(showing && localVisibility)+", "+s(e));
}
} else if(DEBUG) {
System.err.println("JAWTWindow.hierarchyChanged SHOWING_CHANGED (x): showing "+showing+" -> visible "+(showing && localVisibility)+", "+s(e));
}
}
}
}

protected synchronized void invalidate() {
Expand Down Expand Up @@ -488,7 +563,6 @@ public void destroy() {
surfaceLock.lock();
try {
invalidate();
component = null; // don't dispose the AWT component, since we are merely an immutable uplink
} finally {
surfaceLock.unlock();
}
Expand Down Expand Up @@ -638,12 +712,8 @@ public String toString() {
", surfaceHandle "+toHexString(getSurfaceHandle())+
", bounds "+bounds+", insets "+insets
);
if(null!=component) {
sb.append(", pos "+getX()+"/"+getY()+", size "+getWidth()+"x"+getHeight()+
", visible "+component.isVisible());
} else {
sb.append(", component NULL");
}
sb.append(", pos "+getX()+"/"+getY()+", size "+getWidth()+"x"+getHeight()+
", visible "+component.isVisible());
sb.append(", lockedExt "+isSurfaceLockedByOtherThread()+
",\n\tconfig "+getPrivateGraphicsConfiguration()+
",\n\tawtComponent "+getAWTComponent()+
Expand Down
18 changes: 14 additions & 4 deletions ...ogl/awt/TestBug816OSXCALayerPos03AWT.java → ...gl/awt/TestBug816OSXCALayerPos03aAWT.java
View file
Expand Up @@ -54,21 +54,31 @@
import com.jogamp.opengl.util.Animator;

/**
* Bug 816: OSX CALayer Positioning Bug - AWT Frame BorderLayout w/ Checkbox North, GLCanvas Center
* AWT Frame BorderLayout w/ Checkbox North, GLCanvas Center.
* <p>
* Checkbox toggles GLCanvas visibility state.
* </p>
* <p>
* Validates bugs:
* <ul>
* <li>Bug 816: OSX CALayer Positioning Bug</li>
* <li>Bug 729: OSX CALayer shall honor the Component's visibility state</li>
* </ul>
* </p>
* <p>
* Diff. OSX CALayer positioning w/ java6, [7uxx..7u40[, and >= 7u40
* </p>
*/
@FixMethodOrder(MethodSorters.NAME_ASCENDING)
public class TestBug816OSXCALayerPos03AWT extends UITestCase {
public class TestBug816OSXCALayerPos03aAWT extends UITestCase {
static long duration = 1600; // ms
static int width=640, height=480;

@Test
public void test() throws InterruptedException, InvocationTargetException {
final GLCapabilities caps = new GLCapabilities(getGLP());

final Frame frame = new Frame("TestBug816OSXCALayerPos03AWT");
final Frame frame = new Frame("TestBug816OSXCALayerPos03aAWT");
Assert.assertNotNull(frame);

final GLCanvas glCanvas1 = new GLCanvas(caps);
Expand Down Expand Up @@ -150,6 +160,6 @@ public static void main(String args[]) {
}
}

org.junit.runner.JUnitCore.main(TestBug816OSXCALayerPos03AWT.class.getName());
org.junit.runner.JUnitCore.main(TestBug816OSXCALayerPos03aAWT.class.getName());
}
}

0 comments on commit e33e637

Please sign in to comment.