public class GlimpseLayout extends Object implements GlimpsePainter, GlimpseTarget, Mouseable
GlimpseLayout uses a delegate class GlimpseLayoutDelegate
to interface with Mig Layout and hold transient state during layout operations.
The final results of the layout are stored in a LayoutCache
.
Don't forget the "bottomtotop" layout constraint for MiG, or things will be upside-down from what you probably expect.
GlimpseLayoutDelegate
Constructor and Description |
---|
GlimpseLayout() |
GlimpseLayout(GlimpseLayout parent) |
GlimpseLayout(GlimpseLayout parent,
String name) |
GlimpseLayout(String name) |
Modifier and Type | Method and Description |
---|---|
void |
addGlimpseMouseAllListener(GlimpseMouseAllListener listener) |
void |
addGlimpseMouseListener(GlimpseMouseListener listener) |
void |
addGlimpseMouseMotionListener(GlimpseMouseMotionListener listener) |
void |
addGlimpseMouseWheelListener(GlimpseMouseWheelListener listener) |
void |
addLayout(GlimpseLayout layout)
Adds a sub-layout to this GlimpseTarget which will only paint in a region of this GlimpseTarget
based on its layout constraints.
|
void |
addLayout(GlimpseLayout layout,
GlimpsePainterCallback callback) |
void |
addLayout(GlimpseLayout layout,
GlimpsePainterCallback callback,
int zOrder) |
void |
addLayout(GlimpseLayout layout,
int zOrder) |
void |
addPainter(GlimpsePainter painter) |
void |
addPainter(GlimpsePainter painter,
GlimpsePainterCallback callback) |
void |
addPainter(GlimpsePainter painter,
GlimpsePainterCallback callback,
int zOrder) |
void |
addPainter(GlimpsePainter painter,
int zOrder) |
void |
dispose(GlimpseContext context)
Free GPU and CPU memory associated with this this GlimpsePainter.
|
Collection<GlimpseMouseListener> |
getGlimpseMouseListeners() |
Collection<GlimpseMouseMotionListener> |
getGlimpseMouseMotionListeners() |
Collection<GlimpseMouseWheelListener> |
getGlimpseMouseWheelListeners() |
GlimpseLayoutManager |
getLayoutManager() |
ReentrantLock |
getLock() |
String |
getName() |
GlimpseBounds |
getTargetBounds(GlimpseTargetStack stack)
Returns the cached or calculated bounds of this GlimpseTarget for a particular context.
|
List<GlimpseTarget> |
getTargetChildren() |
void |
invalidateLayout() |
boolean |
isDisposed() |
boolean |
isEventConsumer()
Event consumers do not pass on mouse events to their parents.
|
boolean |
isEventGenerator()
Event generators do not generate mouse events if they are the top layout
when a mouse event occurs.
|
boolean |
isVisible()
If true, the GlimpseTarget should be drawn on the screen and mouse events
should be dispatched for it.
|
GlimpseBounds |
layoutTo(GlimpseContext context) |
GlimpseBounds |
layoutTo(GlimpseTargetStack stack) |
void |
mouseEntered(GlimpseMouseEvent event) |
void |
mouseExited(GlimpseMouseEvent event) |
void |
mouseMoved(GlimpseMouseEvent event) |
void |
mousePressed(GlimpseMouseEvent event) |
void |
mouseReleased(GlimpseMouseEvent event) |
void |
mouseWheelMoved(GlimpseMouseEvent event) |
void |
paintTo(GlimpseContext context)
Renders this GlimpsePainter to the provided GlimpseContext.
|
void |
removeAll()
Deprecated.
|
void |
removeAllGlimpseListeners() |
void |
removeAllLayouts()
Removes all GlimpseLayouts added via
#addLayout(GlimpseLayout) . |
void |
removeGlimpseMouseAllListener(GlimpseMouseAllListener listener) |
void |
removeGlimpseMouseListener(GlimpseMouseListener listener) |
void |
removeGlimpseMouseMotionListener(GlimpseMouseMotionListener listener) |
void |
removeGlimpseMouseWheelListener(GlimpseMouseWheelListener listener) |
void |
removeLayout(GlimpseLayout layout)
Removes a previously added layout from this GlimpseTarget.
|
void |
removePainter(GlimpsePainter painter) |
void |
setEventConsumer(boolean consume)
Set whether or not this GlimpseTarget will consume or pass through mouse events.
|
void |
setEventGenerator(boolean generate)
Set whether or not this GlimpseTarget will generate GlimpseMouseEvents.
|
void |
setLayoutData(Object layoutData) |
void |
setLayoutManager(GlimpseLayoutManager manager) |
void |
setLookAndFeel(LookAndFeel laf)
Sets display options for the painter based on the provided LookAndFeel.
|
void |
setName(String name) |
void |
setVisible(boolean visible)
A painter which is set to non-visible should make no OpenGL calls when its
paintTo method is called.
|
void |
setZOrder(GlimpseLayout layout,
int zOrder) |
void |
setZOrder(GlimpsePainter painter,
int zOrder)
Sets the relative ordering constant for this painter.
|
String |
toString() |
public GlimpseLayout(GlimpseLayout parent, String name)
public GlimpseLayout(GlimpseLayout parent)
public GlimpseLayout(String name)
public GlimpseLayout()
public ReentrantLock getLock()
public String getName()
public void setName(String name)
public void setLayoutManager(GlimpseLayoutManager manager)
public void setLayoutData(Object layoutData)
public void removeLayout(GlimpseLayout layout)
GlimpseTarget
removeLayout
in interface GlimpseTarget
public void removeAllLayouts()
#addLayout(GlimpseLayout)
.removeAllLayouts
in interface GlimpseTarget
public void removeAll()
removeAllLayouts()
public void setZOrder(GlimpseLayout layout, int zOrder)
setZOrder
in interface GlimpseTarget
#setZOrder(GlimpseLayout, int)}
public void setZOrder(GlimpsePainter painter, int zOrder)
Sets the relative ordering constant for this painter. Painters with low z order will be painter first (in the back) and those with high z order will be painted last (in the front).
The value itself has no meaning; it is relative to the z orders
of the other painters in the GlimpseLayout.
For com.metsci.glimpse.layout.com.metsciGlimpseLayout
instances,
the z order also affects the order in which mouse events are delivered to
overlapping components.
The z order is set to 0 by default. GlimpsePainters with the same z order are painted in the order they were added to the GlimpseLayout. This means the first painters added will be obscured by later painters.
public void addLayout(GlimpseLayout layout)
GlimpseTarget
addLayout
in interface GlimpseTarget
public void addLayout(GlimpseLayout layout, GlimpsePainterCallback callback)
public void addLayout(GlimpseLayout layout, int zOrder)
addLayout
in interface GlimpseTarget
public void addLayout(GlimpseLayout layout, GlimpsePainterCallback callback, int zOrder)
public void addPainter(GlimpsePainter painter)
public void addPainter(GlimpsePainter painter, GlimpsePainterCallback callback)
public void addPainter(GlimpsePainter painter, int zOrder)
public void addPainter(GlimpsePainter painter, GlimpsePainterCallback callback, int zOrder)
public void removePainter(GlimpsePainter painter)
public void invalidateLayout()
public GlimpseBounds layoutTo(GlimpseTargetStack stack)
public GlimpseBounds layoutTo(GlimpseContext context)
public void paintTo(GlimpseContext context)
GlimpsePainter
paintTo
in interface GlimpsePainter
public GlimpseBounds getTargetBounds(GlimpseTargetStack stack)
GlimpseTarget
getTargetBounds
in interface GlimpseTarget
public List<GlimpseTarget> getTargetChildren()
getTargetChildren
in interface GlimpseTarget
public void dispose(GlimpseContext context)
GlimpsePainter
dispose
in interface GlimpsePainter
public boolean isDisposed()
isDisposed
in interface GlimpsePainter
public Collection<GlimpseMouseListener> getGlimpseMouseListeners()
getGlimpseMouseListeners
in interface Mouseable
public Collection<GlimpseMouseMotionListener> getGlimpseMouseMotionListeners()
getGlimpseMouseMotionListeners
in interface Mouseable
public Collection<GlimpseMouseWheelListener> getGlimpseMouseWheelListeners()
getGlimpseMouseWheelListeners
in interface Mouseable
public void addGlimpseMouseListener(GlimpseMouseListener listener)
addGlimpseMouseListener
in interface Mouseable
public void addGlimpseMouseMotionListener(GlimpseMouseMotionListener listener)
addGlimpseMouseMotionListener
in interface Mouseable
public void addGlimpseMouseWheelListener(GlimpseMouseWheelListener listener)
addGlimpseMouseWheelListener
in interface Mouseable
public void addGlimpseMouseAllListener(GlimpseMouseAllListener listener)
addGlimpseMouseAllListener
in interface Mouseable
public void removeGlimpseMouseAllListener(GlimpseMouseAllListener listener)
removeGlimpseMouseAllListener
in interface Mouseable
public void removeGlimpseMouseListener(GlimpseMouseListener listener)
removeGlimpseMouseListener
in interface Mouseable
public void removeGlimpseMouseMotionListener(GlimpseMouseMotionListener listener)
removeGlimpseMouseMotionListener
in interface Mouseable
public void removeGlimpseMouseWheelListener(GlimpseMouseWheelListener listener)
removeGlimpseMouseWheelListener
in interface Mouseable
public void removeAllGlimpseListeners()
removeAllGlimpseListeners
in interface Mouseable
public GlimpseLayoutManager getLayoutManager()
public void mouseEntered(GlimpseMouseEvent event)
mouseEntered
in interface GlimpseMouseListener
public void mouseExited(GlimpseMouseEvent event)
mouseExited
in interface GlimpseMouseListener
public void mousePressed(GlimpseMouseEvent event)
mousePressed
in interface GlimpseMouseListener
public void mouseReleased(GlimpseMouseEvent event)
mouseReleased
in interface GlimpseMouseListener
public void mouseMoved(GlimpseMouseEvent event)
mouseMoved
in interface GlimpseMouseMotionListener
public void mouseWheelMoved(GlimpseMouseEvent event)
mouseWheelMoved
in interface GlimpseMouseWheelListener
public void setLookAndFeel(LookAndFeel laf)
GlimpsePainter
setLookAndFeel
in interface GlimpseTarget
setLookAndFeel
in interface GlimpsePainter
public boolean isEventConsumer()
isEventConsumer
in interface GlimpseTarget
public void setEventConsumer(boolean consume)
GlimpseTarget
setEventConsumer
in interface GlimpseTarget
public boolean isEventGenerator()
isEventGenerator
in interface GlimpseTarget
public void setEventGenerator(boolean generate)
GlimpseTarget
setEventGenerator
in interface GlimpseTarget
public void setVisible(boolean visible)
GlimpsePainter
setVisible
in interface GlimpsePainter
public boolean isVisible()
GlimpseTarget
isVisible
in interface GlimpseTarget
isVisible
in interface GlimpsePainter
Copyright © 2016 Metron, Inc.. All rights reserved.