Displayable (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- ini.trakem2.persistence.DBObject
- - ini.trakem2.display.Displayable

All Implemented Interfaces:

Paintable

Direct Known Subclasses:

DLabel, LayerSet, Patch, Profile, ZDisplayable
```
public abstract class Displayable
extends DBObject
implements Paintable
```
The class that any element to be drawn on a Display must extend.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`Displayable.DataPackage`
`protected static class`	`Displayable.DoEdit` For any Displayable data, including: title, visible, locked, color, alpha, and a 'data' type which includes the actual data (points, areas, etc.) and the links,width,height, and transformation (since all the latter are correlated).
`protected static class`	`Displayable.DoEdits`
`protected static class`	`Displayable.DoTransforms`
`protected class`	`Displayable.SliderListener`

Field Summary

Fields
Modifier and Type	Field and Description
`protected float`	`alpha`
`protected String`	`annotation`
`protected AffineTransform`	`at`
`protected Color`	`color`
`static byte`	`COMPOSITE_ADD`
`static byte`	`COMPOSITE_COLOR_YCBCR`
`static byte`	`COMPOSITE_DIFFERENCE`
`static byte`	`COMPOSITE_MULTIPLY`
`static byte`	`COMPOSITE_NORMAL`
`static byte`	`COMPOSITE_SUBTRACT`
`protected static String[]`	`compositeModes`
`protected float`	`height` Width and height of the data, not the bounding box.
`protected HashSet<Displayable>`	`hs_linked` The Displayable objects this one is linked to.
`protected static Color`	`last_color`
`protected Layer`	`layer`
`protected Map<Displayable,Map<String,String>>`	`linked_props` The table of tables of properties: for any target Displayable, there is a set of properties specific of the relationship between this Displayable and the target one.
`protected Set<Displayable>`	`linked_props_origins` The call back hooks to remove any linked properties in other Displayable instances when this Displayable is removed.
`protected boolean`	`locked`
`protected Map<String,String>`	`props` The table of key/value property pairs of this Displayable.
`protected static String`	`TAG_ATTR1`
`protected static String`	`TAG_ATTR2`
`protected String`	`title`
`protected boolean`	`visible`
`protected float`	`width` Width and height of the data, not the bounding box.

Fields inherited from class ini.trakem2.persistence.DBObject
id, project

Constructor Summary

Constructors
Constructor and Description
`Displayable(Project project, long id, HashMap<String,String> ht, HashMap<Displayable,String> ht_links)` Reconstruct a Displayable from an XML entry.
`Displayable(Project project, long id, String title, boolean locked, AffineTransform at, float width, float height)` Reconstruct a Displayable from the database.
`Displayable(Project project, String title, double x, double y)` The minimal public Displayable constructor.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`adjustProperties()` Shows a dialog to adjust properties of this object.
`static boolean`	`areThereLayerCrossLinks(Set<Layer> sublist, boolean ignore_stacks)` Returns true if any Displayable objects of different layers in sublist are linked to each other.
`boolean`	`canSendTo(Layer layer)` Subclasses can specify the behaviour, for the default is true.
`Displayable`	`clone()` Performs a deep copy of this object.
`Displayable`	`clone(Project pr)` Performs a deep copy of this object but assigning to it the given project.
`abstract Displayable`	`clone(Project pr, boolean copy_id)` Performs a deep copy of this object, obtaining its unique id either from the given project or the exact same as this object's id.
`protected static String`	`commonDTDChildren()`
`boolean`	`contains(double x_p, double y_p)` Test whether the given point falls within the perimeter of this Displayable, considering the position x,y.
`boolean`	`contains(Layer layer, double x_p, double y_p)` Calls contains(x_p, y_p) unless overriden -- in ZDisplayable objects, it tests whether the given point is contained in the part of the ZDisplayable that shows in the given layer.
`void`	`deselect()` Tell this Displayable that is has been deselected from a Display.
`void`	`destroy()` Release resources.
`static double[][]`	`displacePoints(double[][] p, double dx, double dy)`
`static void`	`exportDTD(StringBuilder sb_header, HashSet<String> hs, String indent)`
`static void`	`exportDTD(String type, StringBuilder sb_header, HashSet<String> hs, String indent)` Adds simply DTD !ATTRIBUTE tags.
`void`	`exportSVG(StringBuffer data, double z_scale, String indent)` Does nothing unless overriden.
`void`	`exportXML(StringBuilder sb_body, String in, XMLOptions options)` The oid is this objects' id, whereas the 'id' tag will be the id of the wrapper Thing object.
`DBObject`	`findById(long id)`
`protected static int`	`findNearestPoint(double[][] a, int n_points, double x_p, double y_p)` Fine nearest point in array a, from 0 up to n_points, to point x_p,y_p.
`protected static int`	`findNearestPoint(double[][] a, long[] p_layer, int n_points, double x_p, double y_p, long lid)`
`AffineTransform`	`getAffineTransform()`
`AffineTransform`	`getAffineTransformCopy()`
`float`	`getAlpha()`
`String`	`getAnnotation()` Returns null if none.
`Area`	`getArea()`
`Area`	`getAreaAt(Layer layer)` This area is meant to represent the entire area where a Displayable paints to in the @param layer.
`protected Area`	`getAreaForBucket(Layer layer)` Should call getAreaAt(layer), or methods that are similar but faster.
`Rectangle`	`getBoundingBox()` Bounding box of the transformed data.
`static Rectangle`	`getBoundingBox(Collection<? extends Displayable> ds, Rectangle r)` Bounding box of a collection of transformed `Displayable`s.
`Rectangle`	`getBoundingBox(Rectangle r)` Bounding box of the transformed data.
`protected Rectangle`	`getBounds(Rectangle r)` Bounding box of the transformed data (or 0,0,0,0 when no data).
`Rectangle`	`getBounds(Rectangle r, Layer layer)` Will fill bounding box values into given rectangle -- only that part of this object showing in the given layer will be included in the box.
`Bucketable`	`getBucketable()`
`Color`	`getColor()`
`protected Composite`	`getComposite(byte mode)`
`static Composite`	`getComposite(byte mode, float alpha)`
`byte`	`getCompositeMode()`
`float`	`getHeight()` Returns the height of the data.
`Area`	`getIntersection(Displayable d)` Returns the intersection of this Displayable's area with the given one.
`Layer`	`getLayer()`
`Collection<Long>`	`getLayerIds()`
`LayerSet`	`getLayerSet()`
`Collection<Layer>`	`getLayersWithData()` Override it to provide Layer pointers directly.
`HashSet<Displayable>`	`getLinked()` Return the HashSet of directly linked Displayable objects.
`HashSet<Displayable>`	`getLinked(Class<?> c)` Return those of Class c from among the directly linked.
`Rectangle`	`getLinkedBox(boolean same_layer)` Returns the sum of bounding boxes of all linked Displayables.
`HashSet<Displayable>`	`getLinkedGroup(HashSet<Displayable> hs)` Return the HashSet of all directly and indirectly linked objects.
`Map<Displayable,Map<String,String>>`	`getLinkedProperties()` Returns a copy of this object's linked properties, which may be empty.
`Map<String,String>`	`getLinkedProperties(Displayable target)` Returns a copy of this object's linked properties table for the given Displayable, which may be empty.
`String`	`getLinkedProperty(Displayable target, String key)` If the key is null or not found, or the aren't any properties linked to the target, returns null; otherwise returns the stored value for key and target.
`String`	`getLinkedProperty(Displayable target, String key, String default_value)` If the key is null or not found, or the aren't any properties linked to the target, returns default_value; otherwise returns the stored value for key and target.
`static Rectangle`	`getMinimalBoundingBox(Displayable[] d)`
`protected double`	`getNameId()` If the title is purely numeric, returns it as a double; otherwise returns 0.
`Polygon`	`getPerimeter()` Subclasses can override this method to provide the exact contour, otherwise it returns the transformed bounding box of the data.
`Polygon`	`getPerimeter(int w, int n, int e, int s)` Returns the perimeter enlarged in all West, North, East and South directions, in pixels.
`Map<String,String>`	`getProperties()` Returns a copy of this object's properties, or null if none.
`String`	`getProperty(String key)` If key is null or not found, returns null; otherwise returns the stored value for key.
`String`	`getProperty(String key, String default_value)` If key is null or not found, returns default_value; otherwise returns the stored value for key.
`String`	`getShortTitle()` Sublcasses can override this method to provide a proper String, otherwise calls getTitle()
`String`	`getTitle()` Sublcasses can override this method to provide a proper String, otherwise calls toString()
`float`	`getWidth()` Returns the width of the data.
`int`	`getX()` Returns the x of the bounding box.
`static String`	`getXMLSafeValue(Map.Entry<String,String> e, String value)` Make sure the value is valid for an XML attribute content inside double quotes.
`static String`	`getXMLSafeValue(String value)`
`int`	`getY()` Returns the y of the bounding box.
`boolean`	`hasLinkedGroupWithinLayer(Layer la)`
`boolean`	`hasProperties()`
`boolean`	`intersects(Area area)`
`boolean`	`intersects(Displayable d)` Check if this perimeter's intersects that of the given Displayable.
`boolean`	`intersects(Layer layer, Area area)` Calls intersects(area) unless overriden -- intended for ZDisplayable objects to return whether they intersect the given area at the given layer.
`boolean`	`intersects(Layer layer, Rectangle r)`
`Point2D.Double`	`inverseTransformPoint(double px, double py)`
`abstract boolean`	`isDeletable()`
`boolean`	`isLinked()` Check if this object is directly linked to any other Displayable objects.
`boolean`	`isLinked(Class<?> c)` Check if this object is directly linked to a Displayable object of the given Class.
`boolean`	`isLinked(Displayable d)` Check if thisobject is directly linked to the given Displayable.
`boolean`	`isLocked()` Check if this or any of the Displayables in the linked group is locked.
`boolean`	`isLocked2()` Return the value of the field 'locked'.
`boolean`	`isOnlyLinkedTo(Class<?> c)` Check if this object is directly linked only to Displayable objects of the given class (returns true) or to none (returns true as well).
`boolean`	`isOnlyLinkedTo(Class<?> c, Layer layer)` Check if this object is directly linked only to Displayable objects of the given class in the same layer (returns true).
`boolean`	`isOutOfRepaintingClip(double magnification, Rectangle srcRect, Rectangle clipRect)`
`boolean`	`isOutOfRepaintingClip(Rectangle clipRect, double scale)` For the DisplayNavigator.
`protected boolean`	`isRoughlyInside(Layer layer, Rectangle r)` If this Displayable intersects with @param r or almost intersects, then returns true.
`boolean`	`isVisible()`
`void`	`keyPressed(KeyEvent ke)`
`void`	`link(Displayable d)` Link the given Displayable with this Displayable, and then tell the given Displayable to link this.
`void`	`link(Displayable d, boolean update_database)` Link the given Displayable with this Displayable, and then tell the given Displayable to link this.
`boolean`	`linkPatches()` Link the Patch objects that lay underneath the bounding box of this Displayable, so that they cannot be dragged independently.
`protected GenericDialog`	`makeAdjustPropertiesDialog()`
`ij.measure.ResultsTable`	`measure(ij.measure.ResultsTable rt)` Does nothing unless overriden.
`void`	`mouseDragged(MouseEvent me, Layer layer, int x_p, int y_p, int x_d, int y_d, int x_d_old, int y_d_old)`
`void`	`mousePressed(MouseEvent me, Layer layer, int x_p, int y_p, double mag)`
`void`	`mouseReleased(MouseEvent me, Layer layer, int x_p, int y_p, int x_d, int y_d, int x_r, int y_r)`
`void`	`mouseWheelMoved(MouseWheelEvent mwe)` Does nothing unless overriden.
`void`	`paint(Graphics2D g, Rectangle srcRect, double magnification, boolean active, int channels, Layer active_layer, List<Layer> layers)`
`void`	`paintAsBox(Graphics2D g)`
`void`	`paintOffscreen(Graphics2D g, Rectangle srcRect, double magnification, boolean active, int channels, Layer active_layer, List<Layer> layers)` Paints waiting for data to load, if necessary.
`void`	`paintSnapshot(Graphics2D g, Layer layer, List<Layer> layers, Rectangle srcRect, double mag)`
`static void`	`preConcatenate(AffineTransform at, Collection<Displayable> ds)` Preconcatenate the `at` to every `Displayable` in `ds`, without touching their links; then the buckets are updated for all necessary layers.
`void`	`prePaint(Graphics2D g, Rectangle srcRect, double magnification, boolean active, int channels, Layer active_layer, List<Layer> layers)`
`void`	`preTransform(AffineTransform affine, boolean linked)` preConcatenate the given affine transform to this Displayable's affine.
`protected Displayable.DoEdit`	`processAdjustPropertiesDialog(GenericDialog gd)`
`boolean`	`remove(boolean check)` Remove from both the database and any Display that shows the Layer in which this Displayable is shown.
`protected boolean`	`remove2(boolean check)` Remove also from the trees if present; does nothing more than remove(boolean) unless overriden.
`Map<String,String>`	`removeLinkedProperties(Displayable target)` Removes and returns the table of properties lined to the target Displayable.
`protected void`	`removeLinkedPropertiesFromOrigins()` Tell any other Displayable that has a linked property with this Displayable to remove it.
`void`	`repaint()` Repaint this Displayable in all Display instances that are showing it.
`protected void`	`restXML(StringBuilder sb_body, String in, XMLOptions options)` Add properties, links, etc.
`void`	`rotate(double radians, double xo, double yo)` Rotate relative to an anchor point.
`void`	`rotate(double radians, double xo, double yo, boolean linked)` Rotate relative to an anchor point.
`static double[][]`	`rotatePoints(double[][] p, double rot, double xo, double yo)` Rotate 2D points relative to the given pivot point by the given rot angle (in radians), in the 2D plane.
`void`	`scale(double sx, double sy, double xo, double yo)` Scale relative to an anchor point (will translate as necessary).
`void`	`scale(double sx, double sy, double xo, double yo, boolean linked)` Scale relative to an anchor point (will translate as necessary).
`static double[][]`	`scalePoints(double[][] p, double sx, double sy, double xo, double yo)` Scale 2D points relative to the given pivot point xo,yo.
`void`	`setAffineTransform(AffineTransform at)` Sets the matrix values of this Displayable's AffineTransform to those of the given AffineTransform.
`void`	`setAlpha(float alpha)`
`protected void`	`setAlpha(float alpha, boolean update)`
`void`	`setAnnotation(String annotation)`
`void`	`setColor(Color color)`
`void`	`setCompositeMode(byte mode)` Sets the composite mode, which determines how is this image painted to the screen relative to the other images.
`void`	`setDimensions(double width, double height)` Not accepted if zero or negative.
`void`	`setDimensions(double width, double height, boolean repaint)` Sets the dimensions of the bounding box.
`void`	`setLayer(Layer layer)`
`void`	`setLayer(Layer layer, boolean update_db)`
`void`	`setLinkedProperties(Displayable target, Map<String,String> p)` Add all the properties in map p as properties linked to the target Displayable.
`boolean`	`setLinkedProperty(Displayable target, String key, String value)` Add a property that is specific to the relationship between this Displayable and the target, and will be deleted when the target Displayable is deleted.
`void`	`setLocation(double x, double y)` Sets the top left of the bounding box to x,y.
`void`	`setLocked(boolean lock)` Set the locking state of this Displayable, which affects that of its linked Displayable objects.
`boolean`	`setProperty(String key, String value)` Set a key/valye property pair; to remove a property, set the value to null.
`void`	`setTitle(String title)` Does not accept null or zero-length titles.
`void`	`setVisible(boolean visible)`
`void`	`setVisible(boolean visible, boolean repaint)`
`void`	`snapTo(int cx, int cy, int x_p, int y_p)` Does nothing unless overriden.
`boolean`	`softRemove()` Calls remove(false) unless overriden.
`String`	`toString()` Minimal info that identifies this object as unique, for display on a JTree node.
`void`	`transform(AffineTransform at)` Concatenate the given affine to this and all its linked objects.
`static void`	`transformPoint(double[][] p, int i, double dx, double dy, double rot, double xo, double yo)` Transform in place only the 'i' point in the points array.
`Point2D.Double`	`transformPoint(double px, double py)` Apply this Displayable's AffineTransform to the given point.
`protected static double[]`	`transformPoints(AffineTransform aff, double[] p)`
`protected static double[][]`	`transformPoints(AffineTransform aff, double[][] p, int length)` Will crop second dimension of the given array at the given length.
`protected double[]`	`transformPoints(double[] p)` Transforms the points represented as X1,Y1,X2,Y2...
`double[][]`	`transformPoints(double[][] p)` Returns the argument if this Displayable's AffineTransform is the identity; otherwise returns a new double[][] with all points from @param p transformed according to the AffineTransform.
`double[][]`	`transformPoints(double[][] p, AffineTransform additional)`
`protected double[][]`	`transformPoints(double[][] p, int length)`
`protected double[][]`	`transformPoints(double[][] p, int length, AffineTransform additional)` Will crop second dimension of the given array at the given length.
`protected double[]`	`transformPoints(double[] p, AffineTransform additional)`
`protected float[]`	`transformPoints(float[] p)` Transforms the points represented as X1,Y1,X2,Y2...
`Rectangle`	`transformRectangle(Rectangle r)` Returns a new Rectangle which encloses completly the given rectangle after transforming it with this Displayable's AffineTransform.
`void`	`translate(double dx, double dy)`
`void`	`translate(double dx, double dy, boolean linked)` Translate this Displayable and its linked ones if linked=true.
`void`	`unlink()` Remove all links held by this Displayable.
`void`	`unlink(Displayable d)` Remove the link with the given Displayable, and tell the given Displayable to remove the link with this.
`void`	`unlinkAll(Class<?> c)` Unlink all Displayable objects of the given type linked by this.
`void`	`updateBucket()` Commands the parent container (a Layer or a LayerSet) to update the bucket position of this Displayable.
`boolean`	`updateInDatabase(String key)`
`protected static void`	`xmlError(DBObject dbo, String tag, Object default_value)`
`protected void`	`xmlError(String tag, Object default_value)`

Methods inherited from class ini.trakem2.persistence.DBObject
addToDatabase, getId, getInfo, getProject, getUniqueIdentifier, removeFromDatabase, updateInDatabase

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail
- compositeModes
```
protected static final String[] compositeModes
```
- COMPOSITE_NORMAL
```
public static final byte COMPOSITE_NORMAL
```
  See Also:
  
  Constant Field Values
- COMPOSITE_ADD
```
public static final byte COMPOSITE_ADD
```
  See Also:
  
  Constant Field Values
- COMPOSITE_SUBTRACT
```
public static final byte COMPOSITE_SUBTRACT
```
  See Also:
  
  Constant Field Values
- COMPOSITE_MULTIPLY
```
public static final byte COMPOSITE_MULTIPLY
```
  See Also:
  
  Constant Field Values
- COMPOSITE_DIFFERENCE
```
public static final byte COMPOSITE_DIFFERENCE
```
  See Also:
  
  Constant Field Values
- COMPOSITE_COLOR_YCBCR
```
public static final byte COMPOSITE_COLOR_YCBCR
```
  See Also:
  
  Constant Field Values
- at
```
protected final AffineTransform at
```
- width
```
protected float width
```
  Width and height of the data, not the bounding box. If the AffineTransform is different than identity, then the bounding box will be different.
- height
```
protected float height
```
  Width and height of the data, not the bounding box. If the AffineTransform is different than identity, then the bounding box will be different.
- locked
```
protected boolean locked
```
- title
```
protected String title
```
- annotation
```
protected String annotation
```
- last_color
```
protected static Color last_color
```
- color
```
protected Color color
```
- alpha
```
protected float alpha
```
- visible
```
protected boolean visible
```
- layer
```
protected Layer layer
```
- hs_linked
```
protected HashSet<Displayable> hs_linked
```
  The Displayable objects this one is linked to. Can be null.
- props
```
protected Map<String,String> props
```
  The table of key/value property pairs of this Displayable.
- linked_props
```
protected Map<Displayable,Map<String,String>> linked_props
```
  The table of tables of properties: for any target Displayable, there is a set of properties specific of the relationship between this Displayable and the target one.
- linked_props_origins
```
protected Set<Displayable> linked_props_origins
```
  The call back hooks to remove any linked properties in other Displayable instances when this Displayable is removed.
- TAG_ATTR1
```
protected static final String TAG_ATTR1
```
  See Also:
  
  Constant Field Values
- TAG_ATTR2
```
protected static final String TAG_ATTR2
```
  See Also:
  
  Constant Field Values

Constructor Detail

Displayable

public Displayable(Project project,
                   String title,
                   double x,
                   double y)

The minimal public Displayable constructor.

Displayable

public Displayable(Project project,
                   long id,
                   String title,
                   boolean locked,
                   AffineTransform at,
                   float width,
                   float height)

Reconstruct a Displayable from the database.

Displayable

public Displayable(Project project,
                   long id,
                   HashMap<String,String> ht,
                   HashMap<Displayable,String> ht_links)

Reconstruct a Displayable from an XML entry. Used entries get removed from the HashMap.

Method Detail

getCompositeMode
```
public byte getCompositeMode()
```

getComposite

protected Composite getComposite(byte mode)

setCompositeMode
```
public void setCompositeMode(byte mode)
```
Sets the composite mode, which determines how is this image painted to the screen relative to the other images. For example, a 16-bit image with a red LUT may be set, with the COMPOSITE_COLOR_YCBCR mode, to contribute towards the red channel only of an underlying set of grayscale electron microscopy images.

Parameters:

mode - Any of the COMPOSITE_* modes available.

Throws:

IllegalArgumentException - if the mode is not valid.

getComposite

public static Composite getComposite(byte mode,
                                     float alpha)

setProperty

public boolean setProperty(String key,
                           String value)

Set a key/valye property pair; to remove a property, set the value to null.

getProperty
```
public String getProperty(String key)
```
If key is null or not found, returns null; otherwise returns the stored value for key.

getProperty

public String getProperty(String key,
                          String default_value)

If key is null or not found, returns default_value; otherwise returns the stored value for key.

getProperties
```
public Map<String,String> getProperties()
```
Returns a copy of this object's properties, or null if none.

hasProperties
```
public boolean hasProperties()
```

setLinkedProperty

public boolean setLinkedProperty(Displayable target,
                                 String key,
                                 String value)

Add a property that is specific to the relationship between this Displayable and the target, and will be deleted when the target Displayable is deleted.

setLinkedProperties
```
public void setLinkedProperties(Displayable target,
                                Map<String,String> p)
```
Add all the properties in map p as properties linked to the target Displayable. If any keys already existed their values will be overwritten by those in p. Any keys whose value is null will be removed.

removeLinkedProperties
```
public Map<String,String> removeLinkedProperties(Displayable target)
```
Removes and returns the table of properties lined to the target Displayable. May be empty.

removeLinkedPropertiesFromOrigins
```
protected void removeLinkedPropertiesFromOrigins()
```
Tell any other Displayable that has a linked property with this Displayable to remove it.

getLinkedProperty
```
public String getLinkedProperty(Displayable target,
                                String key)
```
If the key is null or not found, or the aren't any properties linked to the target, returns null; otherwise returns the stored value for key and target.

getLinkedProperty

public String getLinkedProperty(Displayable target,
                                String key,
                                String default_value)

If the key is null or not found, or the aren't any properties linked to the target, returns default_value; otherwise returns the stored value for key and target.

getLinkedProperties
```
public Map<String,String> getLinkedProperties(Displayable target)
```
Returns a copy of this object's linked properties table for the given Displayable, which may be empty.

getLinkedProperties
```
public Map<Displayable,Map<String,String>> getLinkedProperties()
```
Returns a copy of this object's linked properties, which may be empty.

setLocked
```
public void setLocked(boolean lock)
```
Set the locking state of this Displayable, which affects that of its linked Displayable objects. If lock is true, this Displayable is set as locked; any linked Displayable's locked state is not changed, but will behave as locked. If lock is false, this Displayable and all its linked Displayable objects are set as unlocked.

isLocked2
```
public boolean isLocked2()
```
Return the value of the field 'locked'.

isLocked
```
public boolean isLocked()
```
Check if this or any of the Displayables in the linked group is locked.

xmlError

protected final void xmlError(String tag,
                              Object default_value)

xmlError

protected static final void xmlError(DBObject dbo,
                                     String tag,
                                     Object default_value)

paint

public void paint(Graphics2D g,
                  Rectangle srcRect,
                  double magnification,
                  boolean active,
                  int channels,
                  Layer active_layer,
                  List<Layer> layers)

Specified by:: paint in interface Paintable

prePaint

public void prePaint(Graphics2D g,
                     Rectangle srcRect,
                     double magnification,
                     boolean active,
                     int channels,
                     Layer active_layer,
                     List<Layer> layers)

Specified by:: prePaint in interface Paintable

paintOffscreen

public void paintOffscreen(Graphics2D g,
                           Rectangle srcRect,
                           double magnification,
                           boolean active,
                           int channels,
                           Layer active_layer,
                           List<Layer> layers)

Paints waiting for data to load, if necessary.

setDimensions
```
public void setDimensions(double width,
                          double height)
```
Not accepted if zero or negative. Remakes the snapshot, updates the snapshot panel and the Display.

setDimensions
```
public void setDimensions(double width,
                          double height,
                          boolean repaint)
```
Sets the dimensions of the bounding box. Not accepted if zero or negative. If repaint is true, remakes the snapshot, updates the snapshot panel and the Display.

setLayer

public void setLayer(Layer layer,
                     boolean update_db)

setLayer
```
public void setLayer(Layer layer)
```

getLayer
```
public Layer getLayer()
```

setTitle
```
public void setTitle(String title)
```
Does not accept null or zero-length titles.

getTitle
```
public String getTitle()
```
Description copied from class: DBObject

Sublcasses can override this method to provide a proper String, otherwise calls toString()

Overrides:

getTitle in class DBObject

getShortTitle
```
public String getShortTitle()
```
Description copied from class: DBObject

Sublcasses can override this method to provide a proper String, otherwise calls getTitle()

Overrides:

getShortTitle in class DBObject

getX
```
public int getX()
```
Returns the x of the bounding box.

getY
```
public int getY()
```
Returns the y of the bounding box.

getWidth
```
public float getWidth()
```
Returns the width of the data.

getHeight
```
public float getHeight()
```
Returns the height of the data.

getBoundingBox
```
public Rectangle getBoundingBox()
```
Bounding box of the transformed data.

getBounds
```
public Rectangle getBounds(Rectangle r,
                           Layer layer)
```
Will fill bounding box values into given rectangle -- only that part of this object showing in the given layer will be included in the box. If @param r is null, returns a new Rectangle; else, sets the bounds into @param r and returns it. If there aren't any bounds for this object at @param layer, returns either @param r with zero width and zero height, or a new Rectangle with zero width and zero height. Never returns null.

getBoundingBox
```
public Rectangle getBoundingBox(Rectangle r)
```
Bounding box of the transformed data. Saves one Rectangle allocation, returns the same Rectangle, modified (or a new one if null).

getBounds
```
protected Rectangle getBounds(Rectangle r)
```
Bounding box of the transformed data (or 0,0,0,0 when no data). Returns the same Rectangle, modified.

getBoundingBox

public static Rectangle getBoundingBox(Collection<? extends Displayable> ds,
                                       Rectangle r)

Bounding box of a collection of transformed Displayables. If the list is empty, there is no bounding box, so it returns null.

getPerimeter
```
public Polygon getPerimeter()
```
Subclasses can override this method to provide the exact contour, otherwise it returns the transformed bounding box of the data.

getPerimeter

public Polygon getPerimeter(int w,
                            int n,
                            int e,
                            int s)

Returns the perimeter enlarged in all West, North, East and South directions, in pixels.

contains
```
public boolean contains(double x_p,
                        double y_p)
```
Test whether the given point falls within the perimeter of this Displayable, considering the position x,y. Used by the DisplayCanvas mouse events.

contains
```
public boolean contains(Layer layer,
                        double x_p,
                        double y_p)
```
Calls contains(x_p, y_p) unless overriden -- in ZDisplayable objects, it tests whether the given point is contained in the part of the ZDisplayable that shows in the given layer.

setAlpha
```
public void setAlpha(float alpha)
```

setAlpha

protected void setAlpha(float alpha,
                        boolean update)

getAlpha
```
public float getAlpha()
```

getColor
```
public Color getColor()
```

getLinked
```
public HashSet<Displayable> getLinked()
```
Return the HashSet of directly linked Displayable objects.

getLinked
```
public HashSet<Displayable> getLinked(Class<?> c)
```
Return those of Class c from among the directly linked.

getLinkedGroup
```
public HashSet<Displayable> getLinkedGroup(HashSet<Displayable> hs)
```
Return the HashSet of all directly and indirectly linked objects. When no links, then the HashSet contains only this Displayable.

mousePressed

public void mousePressed(MouseEvent me,
                         Layer layer,
                         int x_p,
                         int y_p,
                         double mag)

mouseDragged

public void mouseDragged(MouseEvent me,
                         Layer layer,
                         int x_p,
                         int y_p,
                         int x_d,
                         int y_d,
                         int x_d_old,
                         int y_d_old)

mouseReleased

public void mouseReleased(MouseEvent me,
                          Layer layer,
                          int x_p,
                          int y_p,
                          int x_d,
                          int y_d,
                          int x_r,
                          int y_r)

mouseWheelMoved

public void mouseWheelMoved(MouseWheelEvent mwe)

Does nothing unless overriden.

keyPressed
```
public void keyPressed(KeyEvent ke)
```

isVisible
```
public boolean isVisible()
```

setVisible

public final void setVisible(boolean visible)

setVisible

public void setVisible(boolean visible,
                       boolean repaint)

repaint
```
public void repaint()
```
Repaint this Displayable in all Display instances that are showing it.

setColor
```
public void setColor(Color color)
```

destroy
```
public void destroy()
```
Release resources.

isOutOfRepaintingClip

public boolean isOutOfRepaintingClip(double magnification,
                                     Rectangle srcRect,
                                     Rectangle clipRect)

isOutOfRepaintingClip

public boolean isOutOfRepaintingClip(Rectangle clipRect,
                                     double scale)

For the DisplayNavigator. No srcRect or magnification considered.

remove2
```
protected boolean remove2(boolean check)
```
Remove also from the trees if present; does nothing more than remove(boolean) unless overriden.

remove
```
public boolean remove(boolean check)
```
Remove from both the database and any Display that shows the Layer in which this Displayable is shown.

Overrides:

remove in class DBObject

link
```
public void link(Displayable d)
```
Link the given Displayable with this Displayable, and then tell the given Displayable to link this. Since the link is stored as Displayable objects in a HashSet, there'll never be repeated entries.

link
```
public void link(Displayable d,
                 boolean update_database)
```
Link the given Displayable with this Displayable, and then tell the given Displayable to link this. Since the link is stored as Displayable objects in a HashSet, there'll never be repeated entries.

unlink
```
public void unlink()
```
Remove all links held by this Displayable.

unlink
```
public void unlink(Displayable d)
```
Remove the link with the given Displayable, and tell the given Displayable to remove the link with this.

isLinked
```
public boolean isLinked()
```
Check if this object is directly linked to any other Displayable objects.

isLinked
```
public boolean isLinked(Class<?> c)
```
Check if this object is directly linked to a Displayable object of the given Class.

isLinked
```
public boolean isLinked(Displayable d)
```
Check if thisobject is directly linked to the given Displayable.

isOnlyLinkedTo
```
public boolean isOnlyLinkedTo(Class<?> c)
```
Check if this object is directly linked only to Displayable objects of the given class (returns true) or to none (returns true as well).

isOnlyLinkedTo
```
public boolean isOnlyLinkedTo(Class<?> c,
                              Layer layer)
```
Check if this object is directly linked only to Displayable objects of the given class in the same layer (returns true). Returns true as well when not linked to any of the given class.

linkPatches
```
public boolean linkPatches()
```
Link the Patch objects that lay underneath the bounding box of this Displayable, so that they cannot be dragged independently.

Returns:

whether the locking state changed.

unlinkAll
```
public void unlinkAll(Class<?> c)
```
Unlink all Displayable objects of the given type linked by this.

intersects
```
public boolean intersects(Displayable d)
```
Check if this perimeter's intersects that of the given Displayable.

intersects
```
public boolean intersects(Area area)
```

intersects
```
public boolean intersects(Layer layer,
                          Area area)
```
Calls intersects(area) unless overriden -- intended for ZDisplayable objects to return whether they intersect the given area at the given layer.

intersects

public boolean intersects(Layer layer,
                          Rectangle r)

getIntersection
```
public Area getIntersection(Displayable d)
```
Returns the intersection of this Displayable's area with the given one.

getLinkedBox
```
public Rectangle getLinkedBox(boolean same_layer)
```
Returns the sum of bounding boxes of all linked Displayables.

toString
```
public String toString()
```
Minimal info that identifies this object as unique, for display on a JTree node.

Overrides:

toString in class Object

isDeletable
```
public abstract boolean isDeletable()
```

canSendTo
```
public boolean canSendTo(Layer layer)
```
Subclasses can specify the behaviour, for the default is true.

exportSVG

public void exportSVG(StringBuffer data,
                      double z_scale,
                      String indent)

Does nothing unless overriden.

snapTo
```
public void snapTo(int cx,
                   int cy,
                   int x_p,
                   int y_p)
```
Does nothing unless overriden. Used for profile, pipe and ball points when preventing dragging beyond the screen, to snap to cursor when this reenters.

adjustProperties
```
public void adjustProperties()
```
Shows a dialog to adjust properties of this object.

makeAdjustPropertiesDialog

protected GenericDialog makeAdjustPropertiesDialog()

processAdjustPropertiesDialog

protected Displayable.DoEdit processAdjustPropertiesDialog(GenericDialog gd)

exportDTD

public static void exportDTD(String type,
                             StringBuilder sb_header,
                             HashSet<String> hs,
                             String indent)

Adds simply DTD !ATTRIBUTE tags. The ProjectThing that encapsulates this object will give the type.

exportDTD

public static void exportDTD(StringBuilder sb_header,
                             HashSet<String> hs,
                             String indent)

commonDTDChildren

protected static String commonDTDChildren()

exportXML

public void exportXML(StringBuilder sb_body,
                      String in,
                      XMLOptions options)

The oid is this objects' id, whereas the 'id' tag will be the id of the wrapper Thing object.

Overrides:: exportXML in class DBObject

restXML

protected void restXML(StringBuilder sb_body,
                       String in,
                       XMLOptions options)

Add properties, links, etc. Does NOT close the tag.

getXMLSafeValue
```
public static final String getXMLSafeValue(Map.Entry<String,String> e,
                                           String value)
```
Make sure the value is valid for an XML attribute content inside double quotes. This means double quotes and newline characters are not allowed and are replaced by a single quote and a space, respectively.

getXMLSafeValue

public static final String getXMLSafeValue(String value)

hasLinkedGroupWithinLayer

public boolean hasLinkedGroupWithinLayer(Layer la)

rotatePoints

public static double[][] rotatePoints(double[][] p,
                                      double rot,
                                      double xo,
                                      double yo)

Rotate 2D points relative to the given pivot point by the given rot angle (in radians), in the 2D plane.

scalePoints

public static double[][] scalePoints(double[][] p,
                                     double sx,
                                     double sy,
                                     double xo,
                                     double yo)

Scale 2D points relative to the given pivot point xo,yo.

displacePoints

public static double[][] displacePoints(double[][] p,
                                        double dx,
                                        double dy)

transformPoint

public static void transformPoint(double[][] p,
                                  int i,
                                  double dx,
                                  double dy,
                                  double rot,
                                  double xo,
                                  double yo)

Transform in place only the 'i' point in the points array.

findNearestPoint

protected static int findNearestPoint(double[][] a,
                                      int n_points,
                                      double x_p,
                                      double y_p)

Fine nearest point in array a, from 0 up to n_points, to point x_p,y_p.

Returns:: the index of such point.

findNearestPoint

protected static int findNearestPoint(double[][] a,
                                      long[] p_layer,
                                      int n_points,
                                      double x_p,
                                      double y_p,
                                      long lid)

clone
```
public Displayable clone()
```
Performs a deep copy of this object.

Overrides:

clone in class Object

clone
```
public abstract Displayable clone(Project pr,
                                  boolean copy_id)
```
Performs a deep copy of this object, obtaining its unique id either from the given project or the exact same as this object's id. The visibility, though, is set to true at all times.

clone
```
public Displayable clone(Project pr)
```
Performs a deep copy of this object but assigning to it the given project. The visibility, though, is set to true at all times.

getLayerSet
```
public LayerSet getLayerSet()
```

updateInDatabase
```
public boolean updateInDatabase(String key)
```
Overrides:

updateInDatabase in class DBObject

getMinimalBoundingBox

public static Rectangle getMinimalBoundingBox(Displayable[] d)

getAffineTransform

public AffineTransform getAffineTransform()

getAffineTransformCopy

public AffineTransform getAffineTransformCopy()

setAffineTransform
```
public void setAffineTransform(AffineTransform at)
```
Sets the matrix values of this Displayable's AffineTransform to those of the given AffineTransform.

translate

public void translate(double dx,
                      double dy,
                      boolean linked)

Translate this Displayable and its linked ones if linked=true.

translate

public void translate(double dx,
                      double dy)

rotate

public void rotate(double radians,
                   double xo,
                   double yo)

Rotate relative to an anchor point.

rotate

public void rotate(double radians,
                   double xo,
                   double yo,
                   boolean linked)

Rotate relative to an anchor point.

preConcatenate

public static final void preConcatenate(AffineTransform at,
                                        Collection<Displayable> ds)

Preconcatenate the at to every Displayable in ds, without touching their links; then the buckets are updated for all necessary layers.

updateBucket
```
public void updateBucket()
```
Commands the parent container (a Layer or a LayerSet) to update the bucket position of this Displayable.

scale

public void scale(double sx,
                  double sy,
                  double xo,
                  double yo)

Scale relative to an anchor point (will translate as necessary).

scale

public void scale(double sx,
                  double sy,
                  double xo,
                  double yo,
                  boolean linked)

Scale relative to an anchor point (will translate as necessary).

setLocation
```
public void setLocation(double x,
                        double y)
```
Sets the top left of the bounding box to x,y. Warning: does not check that the object will remain within layer bounds. Does NOT affect linked Displayables.

transformPoint

public Point2D.Double transformPoint(double px,
                                     double py)

Apply this Displayable's AffineTransform to the given point.

inverseTransformPoint

public Point2D.Double inverseTransformPoint(double px,
                                            double py)

transformRectangle
```
public final Rectangle transformRectangle(Rectangle r)
```
Returns a new Rectangle which encloses completly the given rectangle after transforming it with this Displayable's AffineTransform. The given rectangle's fields are untouched.

transformPoints
```
public double[][] transformPoints(double[][] p)
```
Returns the argument if this Displayable's AffineTransform is the identity; otherwise returns a new double[][] with all points from @param p transformed according to the AffineTransform. The double[][] array provided as argument is expected to be of type [2][length], i.e. two arrays describing x and y, and it is left intact.

transformPoints

protected double[][] transformPoints(double[][] p,
                                     int length)

transformPoints

public double[][] transformPoints(double[][] p,
                                  AffineTransform additional)

transformPoints

protected final double[][] transformPoints(double[][] p,
                                           int length,
                                           AffineTransform additional)

Will crop second dimension of the given array at the given length.

transformPoints

protected static final double[][] transformPoints(AffineTransform aff,
                                                  double[][] p,
                                                  int length)

Will crop second dimension of the given array at the given length.

transformPoints

protected double[] transformPoints(double[] p,
                                   AffineTransform additional)

transformPoints

protected static double[] transformPoints(AffineTransform aff,
                                          double[] p)

transformPoints
```
protected double[] transformPoints(double[] p)
```
Transforms the points represented as X1,Y1,X2,Y2...

transformPoints
```
protected float[] transformPoints(float[] p)
```
Transforms the points represented as X1,Y1,X2,Y2...

transform
```
public void transform(AffineTransform at)
```
Concatenate the given affine to this and all its linked objects.

preTransform

public void preTransform(AffineTransform affine,
                         boolean linked)

preConcatenate the given affine transform to this Displayable's affine.

paintAsBox
```
public void paintAsBox(Graphics2D g)
```

paintSnapshot

public void paintSnapshot(Graphics2D g,
                          Layer layer,
                          List<Layer> layers,
                          Rectangle srcRect,
                          double mag)

findById
```
public DBObject findById(long id)
```

measure

public ij.measure.ResultsTable measure(ij.measure.ResultsTable rt)

Does nothing unless overriden.

getBucketable
```
public Bucketable getBucketable()
```

getNameId
```
protected double getNameId()
```
If the title is purely numeric, returns it as a double; otherwise returns 0.

areThereLayerCrossLinks
```
public static final boolean areThereLayerCrossLinks(Set<Layer> sublist,
                                                    boolean ignore_stacks)
```
Returns true if any Displayable objects of different layers in sublist are linked to each other. If ignore_stacks is true, then image links across layers are ignored.

getLayerIds
```
public Collection<Long> getLayerIds()
```

getLayersWithData
```
public Collection<Layer> getLayersWithData()
```
Override it to provide Layer pointers directly.

getArea
```
public Area getArea()
```

getAreaAt
```
public Area getAreaAt(Layer layer)
```
This area is meant to represent the entire area where a Displayable paints to in the @param layer. But for some this is reduced to areas with data, not with interpolated data. For example, a Polyine would show a list of little 1x1 rectangles for each point in the @param layer.

getAreaForBucket
```
protected Area getAreaForBucket(Layer layer)
```
Should call getAreaAt(layer), or methods that are similar but faster.

isRoughlyInside
```
protected boolean isRoughlyInside(Layer layer,
                                  Rectangle r)
```
If this Displayable intersects with @param r or almost intersects, then returns true. This method is meant to be very fast, and err on the "yes" and never on the "no".

setAnnotation

public void setAnnotation(String annotation)

getAnnotation
```
public String getAnnotation()
```
Returns null if none.

softRemove
```
public boolean softRemove()
```
Calls remove(false) unless overriden.

deselect
```
public void deselect()
```
Tell this Displayable that is has been deselected from a Display. If multiple displays have the same Displayable in their Selection, this Diplayabale is to act as if it has been deselected from all.

Class Displayable

Nested Class Summary

Field Summary

Fields inherited from class ini.trakem2.persistence.DBObject

Constructor Summary

Method Summary

Methods inherited from class ini.trakem2.persistence.DBObject

Methods inherited from class java.lang.Object

Field Detail

compositeModes

COMPOSITE_NORMAL

COMPOSITE_ADD

COMPOSITE_SUBTRACT

COMPOSITE_MULTIPLY

COMPOSITE_DIFFERENCE

COMPOSITE_COLOR_YCBCR

at

width

height

locked

title

annotation

last_color

color

alpha

visible

layer

hs_linked

props

linked_props

linked_props_origins

TAG_ATTR1

TAG_ATTR2

Constructor Detail

Displayable

Displayable

Displayable

Method Detail

getCompositeMode

getComposite

setCompositeMode

getComposite

setProperty

getProperty

getProperty

getProperties

hasProperties

setLinkedProperty

setLinkedProperties

removeLinkedProperties

removeLinkedPropertiesFromOrigins

getLinkedProperty

getLinkedProperty

getLinkedProperties

getLinkedProperties

setLocked

isLocked2

isLocked

xmlError

xmlError

paint

prePaint

paintOffscreen

setDimensions

setDimensions

setLayer

setLayer

getLayer

setTitle

getTitle

getShortTitle

getX

getY

getWidth

getHeight

getBoundingBox

getBounds

getBoundingBox

getBounds

getBoundingBox