com.metsci.glimpse.context
Interface GlimpseTargetStack

All Known Implementing Classes:
GlimpseTargetStackImpl

public interface GlimpseTargetStack

A class representing a nested sequence of GlimpseTarget containers and their bounds. The current TargetStack is provided to GlimpsePainters via the current GlimpseContext. The current TargetStack is used by LayoutCache as a key to store the GlimpseBounds for a given GlimpseTarget for each unique TargetStack which it has been rendered to.

Author:
ulman
See Also:
GlimpseLayoutCache, GlimpseContext

Method Summary
 GlimpseBounds getBounds()
           
 java.util.List<GlimpseBounds> getBoundsList()
           
 int getSize()
           
 GlimpseTarget getTarget()
           
 java.util.List<GlimpseTarget> getTargetList()
           
 GlimpseTargetStack pop()
          Removes the top GlimpseTarget / GlimpseBounds pair from the target stack.
 GlimpseTargetStack push(GlimpseTarget target)
          Pushes a GlimpseTarget onto this TargetStack (with dummy GlimpseBounds).
 GlimpseTargetStack push(GlimpseTarget target, GlimpseBounds bounds)
          Adds a new GlimpseTarget and its corresponding GlimpseBounds to the TargetStack.
 GlimpseTargetStack push(GlimpseTargetStack stack)
          Pushes an existing stack onto the top of this stack, merging the two.
 

Method Detail

push

GlimpseTargetStack push(GlimpseTarget target,
                        GlimpseBounds bounds)
Adds a new GlimpseTarget and its corresponding GlimpseBounds to the TargetStack.

Parameters:
target -
bounds -
Returns:
this GlimpseTargetStack (to enable chaining of push calls)

push

GlimpseTargetStack push(GlimpseTarget target)
Pushes a GlimpseTarget onto this TargetStack (with dummy GlimpseBounds).

Parameters:
target -
Returns:
this GlimpseTargetStack (to enable chaining of push calls)

push

GlimpseTargetStack push(GlimpseTargetStack stack)
Pushes an existing stack onto the top of this stack, merging the two.

Parameters:
stack -
Returns:
this GlimpseTargetStack (to enable chaining of push calls)

pop

GlimpseTargetStack pop()
Removes the top GlimpseTarget / GlimpseBounds pair from the target stack.


getTarget

GlimpseTarget getTarget()
Returns:
The GlimpseTarget at the top of the target stack (the highest index)

getBounds

GlimpseBounds getBounds()
Returns:
The GlimpsetBounds associated with the GlimpseTarget at the top of the target stack

getTargetList

java.util.List<GlimpseTarget> getTargetList()

getBoundsList

java.util.List<GlimpseBounds> getBoundsList()

getSize

int getSize()


Copyright © 2012 Metron, Inc.. All Rights Reserved.