ZDisplayable (Fiji Javadocs 0-SNAPSHOT API)

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

All Implemented Interfaces:

Paintable

Direct Known Subclasses:

AreaList, Ball, Dissector, Pipe, Polyline, Stack, Tree
```
public abstract class ZDisplayable
extends Displayable
```
For Pipes and other objects that must be shown in all Layers of a LayerSet.

Nested Class Summary
- Nested classes/interfaces inherited from class ini.trakem2.display.Displayable
  Displayable.DataPackage, Displayable.DoEdit, Displayable.DoEdits, Displayable.DoTransforms, Displayable.SliderListener

Field Summary

Fields
Modifier and Type Field and Description

protected LayerSet layer_set
- Fields inherited from class ini.trakem2.display.Displayable
  alpha, annotation, at, color, COMPOSITE_ADD, COMPOSITE_COLOR_YCBCR, COMPOSITE_DIFFERENCE, COMPOSITE_MULTIPLY, COMPOSITE_NORMAL, COMPOSITE_SUBTRACT, compositeModes, height, hs_linked, last_color, layer, linked_props, linked_props_origins, locked, props, TAG_ATTR1, TAG_ATTR2, title, visible, width
- Fields inherited from class ini.trakem2.persistence.DBObject
  id, project

Fields
Modifier and Type	Field and Description
`protected LayerSet`	`layer_set`

Constructor Summary

Constructors
Constructor and Description
`ZDisplayable(Project project, long id, HashMap<String,String> ht, HashMap<Displayable,String> ht_links)` For reconstruction from an XML file.
`ZDisplayable(Project project, long id, String title, boolean locked, AffineTransform at, float width, float height)` For reconstruction from the database.
`ZDisplayable(Project project, String title, double x, double y)`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`protected abstract boolean`	`calculateBoundingBox(Layer la)`
`boolean`	`crop(List<Layer> range)` Retain the data within the layer range, and through out all the rest.
`static void`	`exportDTD(String type, StringBuilder sb_header, HashSet<String> hs, String indent)`
`void`	`exportXML(StringBuilder sb_body, String indent, XMLOptions options)` The oid is this objects' id, whereas the 'id' tag will be the id of the wrapper Thing object.
`Bucketable`	`getBucketable()`
`abstract Layer`	`getFirstLayer()` Returns the layer of lowest Z coordinate where this ZDisplayable has a point in.
`Collection<Long>`	`getLayerIds()` Get the list of Layer ids on which this ZDisplayable has data on.
`LayerSet`	`getLayerSet()`
`abstract boolean`	`intersects(Area area, double z_first, double z_last)`
`protected boolean`	`layerRemoved(Layer la)` Update internal datastructures to reflect the fact that @param layer has been removed from the containing LayerSet.
`abstract boolean`	`linkPatches()` Link the Patch objects that lay underneath the part of the bounding box of this profile that shows in the current layer, so that they cannot be dragged independently.
`boolean`	`paintsAt(Layer layer)` Check if this instance will paint anything at the level of the given Layer.
`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.
`void`	`setColor(Color color)`
`void`	`setLayer(Layer layer)`
`void`	`setLayerSet(LayerSet layer_set)`
`void`	`setLayerSet(LayerSet layer_set, boolean update_db)`
`void`	`setVisible(boolean visible, boolean repaint)`
`boolean`	`softRemove()` Does not remove from the LayerSet.
`void`	`transformPoints(Layer layer, double dx, double dy, double rot, double xo, double yo)` Deprecated.
`void`	`updateBucket()` Update buckets for all Layers.
`void`	`updateBucket(Layer la)`

Methods inherited from class ini.trakem2.display.Displayable
adjustProperties, areThereLayerCrossLinks, canSendTo, clone, clone, clone, commonDTDChildren, contains, contains, deselect, destroy, displacePoints, exportDTD, exportSVG, findById, findNearestPoint, findNearestPoint, getAffineTransform, getAffineTransformCopy, getAlpha, getAnnotation, getArea, getAreaAt, getAreaForBucket, getBoundingBox, getBoundingBox, getBoundingBox, getBounds, getBounds, getColor, getComposite, getComposite, getCompositeMode, getHeight, getIntersection, getLayer, getLayersWithData, getLinked, getLinked, getLinkedBox, getLinkedGroup, getLinkedProperties, getLinkedProperties, getLinkedProperty, getLinkedProperty, getMinimalBoundingBox, getNameId, getPerimeter, getPerimeter, getProperties, getProperty, getProperty, getShortTitle, getTitle, getWidth, getX, getXMLSafeValue, getXMLSafeValue, getY, hasLinkedGroupWithinLayer, hasProperties, intersects, intersects, intersects, intersects, inverseTransformPoint, isDeletable, isLinked, isLinked, isLinked, isLocked, isLocked2, isOnlyLinkedTo, isOnlyLinkedTo, isOutOfRepaintingClip, isOutOfRepaintingClip, isRoughlyInside, isVisible, keyPressed, link, link, makeAdjustPropertiesDialog, measure, mouseDragged, mousePressed, mouseReleased, mouseWheelMoved, paint, paintAsBox, paintOffscreen, paintSnapshot, preConcatenate, prePaint, preTransform, processAdjustPropertiesDialog, removeLinkedProperties, removeLinkedPropertiesFromOrigins, repaint, restXML, rotate, rotate, rotatePoints, scale, scale, scalePoints, setAffineTransform, setAlpha, setAlpha, setAnnotation, setCompositeMode, setDimensions, setDimensions, setLayer, setLinkedProperties, setLinkedProperty, setLocation, setLocked, setProperty, setTitle, setVisible, snapTo, toString, transform, transformPoint, transformPoint, transformPoints, transformPoints, transformPoints, transformPoints, transformPoints, transformPoints, transformPoints, transformPoints, transformPoints, transformRectangle, translate, translate, unlink, unlink, unlinkAll, updateInDatabase, xmlError, xmlError

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
- layer_set
```
protected LayerSet layer_set
```

Constructor Detail

ZDisplayable

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

ZDisplayable

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

For reconstruction from the database.

ZDisplayable

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

For reconstruction from an XML file.

Method Detail
- setLayerSet
```
public void setLayerSet(LayerSet layer_set)
```
- setLayerSet
```
public void setLayerSet(LayerSet layer_set,
                        boolean update_db)
```
- getLayerSet
```
public LayerSet getLayerSet()
```
  Overrides:
  
  getLayerSet in class Displayable
- setLayer
```
public void setLayer(Layer layer)
```
  Overrides:
  
  setLayer in class Displayable
- linkPatches
```
public abstract boolean linkPatches()
```
  Link the Patch objects that lay underneath the part of the bounding box of this profile that shows in the current layer, so that they cannot be dragged independently.
  
  Overrides:
  
  linkPatches in class Displayable
  
  Returns:
  
  whether the locking state changed.
- getFirstLayer
```
public abstract Layer getFirstLayer()
```
  Returns the layer of lowest Z coordinate where this ZDisplayable has a point in.
- exportXML
```
public void exportXML(StringBuilder sb_body,
                      String indent,
                      XMLOptions options)
```
  Description copied from class: Displayable
  
  The oid is this objects' id, whereas the 'id' tag will be the id of the wrapper Thing object.
  
  Overrides:
  
  exportXML in class Displayable
- exportDTD
```
public static void exportDTD(String type,
                             StringBuilder sb_header,
                             HashSet<String> hs,
                             String indent)
```
- transformPoints
```
@Deprecated
public void transformPoints(Layer layer,
                                        double dx,
                                        double dy,
                                        double rot,
                                        double xo,
                                        double yo)
```
  Deprecated.
  
  Transform points falling within the given layer; translate by dx,dy and rotate by rot relative to origin xo,yo
- remove2
```
protected boolean remove2(boolean check)
```
  Description copied from class: Displayable
  
  Remove also from the trees if present; does nothing more than remove(boolean) unless overriden.
  
  Overrides:
  
  remove2 in class Displayable
- remove
```
public boolean remove(boolean check)
```
  Description copied from class: Displayable
  
  Remove from both the database and any Display that shows the Layer in which this Displayable is shown.
  
  Overrides:
  
  remove in class Displayable
- softRemove
```
public boolean softRemove()
```
  Does not remove from the LayerSet.
  
  Overrides:
  
  softRemove in class Displayable
- paintsAt
```
public boolean paintsAt(Layer layer)
```
  Check if this instance will paint anything at the level of the given Layer.
- getLayerIds
```
public Collection<Long> getLayerIds()
```
  Get the list of Layer ids on which this ZDisplayable has data on.
  
  Overrides:
  
  getLayerIds in class Displayable
- setColor
```
public void setColor(Color color)
```
  Overrides:
  
  setColor in class Displayable
- intersects
```
public abstract boolean intersects(Area area,
                                   double z_first,
                                   double z_last)
```
- setVisible
```
public void setVisible(boolean visible,
                       boolean repaint)
```
  Overrides:
  
  setVisible in class Displayable
- getBucketable
```
public Bucketable getBucketable()
```
  Overrides:
  
  getBucketable in class Displayable
- crop
```
public boolean crop(List<Layer> range)
```
  Retain the data within the layer range, and through out all the rest.
- layerRemoved
```
protected boolean layerRemoved(Layer la)
```
  Update internal datastructures to reflect the fact that @param layer has been removed from the containing LayerSet.
- updateBucket
```
public void updateBucket(Layer la)
```
- updateBucket
```
public void updateBucket()
```
  Update buckets for all Layers.
  
  Overrides:
  
  updateBucket in class Displayable
- calculateBoundingBox
```
protected abstract boolean calculateBoundingBox(Layer la)
```

Class ZDisplayable

Nested Class Summary

Nested classes/interfaces inherited from class ini.trakem2.display.Displayable

Field Summary

Fields inherited from class ini.trakem2.display.Displayable

Fields inherited from class ini.trakem2.persistence.DBObject

Constructor Summary

Method Summary

Methods inherited from class ini.trakem2.display.Displayable

Methods inherited from class ini.trakem2.persistence.DBObject

Methods inherited from class java.lang.Object

Field Detail

layer_set

Constructor Detail

ZDisplayable

ZDisplayable

ZDisplayable

Method Detail

setLayerSet

setLayerSet

getLayerSet

setLayer

linkPatches

getFirstLayer

exportXML

exportDTD

transformPoints

remove2

remove

softRemove

paintsAt

getLayerIds

setColor

intersects

setVisible

getBucketable

crop

layerRemoved

updateBucket

updateBucket

calculateBoundingBox