DLabel (Fiji Javadocs 0-SNAPSHOT API)

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

All Implemented Interfaces:

Paintable, VectorData
```
public class DLabel
extends Displayable
implements VectorData
```
This class is named funny to avoid confusion with java.awt.Label. The 'D' stands for Displayable Label. Types: - text - arrow - dot All of them can contain text, editable through double-click.

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

static int ARROW

static int DOT

static int TEXT
- 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
`static int`	`ARROW`
`static int`	`DOT`
`static int`	`TEXT`

Constructor Summary

Constructors
Constructor and Description
`DLabel(Project project, long id, HashMap<String,String> ht, HashMap<Displayable,String> ht_links)` To reconstruct from an XML entry.
`DLabel(Project project, long id, String text, float width, float height, int type, String font_name, int font_style, int font_size, boolean locked, AffineTransform at)` For reconstruction purposes.
`DLabel(Project project, String text, double x, double y)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`adjustProperties()` Shows a dialog to adjust properties of this object.
`boolean`	`apply(Layer la, Area roi, CoordinateTransform ict)` Applies the 2D transform @ict (which is expected to operate on the world coordinates version of the data contained here) only to the data that falls within the @param roi (in world coords), and then recomputes the bounding box and affine transform (to a translation or identity).
`boolean`	`apply(VectorDataTransform vdt)`
`DLabel`	`clone(Project pr, boolean copy_id)` Performs a deep copy of this object, except for the Layer pointer.
`void`	`edit()`
`static void`	`exportDTD(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.
`void`	`flush()`
`Rectangle`	`getBoundingBox(Rectangle r)` Saves one allocation, returns the same Rectangle, modified (or a new one if null).
`Font`	`getFont()`
`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.
`String`	`getShortTitle()` Sublcasses can override this method to provide a proper String, otherwise calls getTitle()
`int`	`getType()`
`boolean`	`isDeletable()`
`void`	`keyPressed(KeyEvent ke)`
`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`	`paint(Graphics2D g, Rectangle srcRect, double magnification, boolean active, int channels, Layer active_layer, List<Layer> layers)`
`void`	`setText(String title, boolean update)`
`void`	`setTitle(String title)` Does not accept null or zero-length titles.
`void`	`setType(int type)`
`String`	`toString()` Minimal info that identifies this object as unique, for display on a JTree node.

Methods inherited from class ini.trakem2.display.Displayable
areThereLayerCrossLinks, canSendTo, clone, clone, commonDTDChildren, contains, contains, deselect, destroy, displacePoints, exportDTD, exportSVG, findById, findNearestPoint, findNearestPoint, getAffineTransform, getAffineTransformCopy, getAlpha, getAnnotation, getArea, getAreaAt, getAreaForBucket, getBoundingBox, getBoundingBox, getBounds, getBounds, getBucketable, getColor, getComposite, getComposite, getCompositeMode, getHeight, getIntersection, getLayer, getLayerIds, getLayerSet, getLayersWithData, getLinked, getLinked, getLinkedBox, getLinkedGroup, getLinkedProperties, getLinkedProperties, getLinkedProperty, getLinkedProperty, getMinimalBoundingBox, getNameId, getProperties, getProperty, getProperty, getTitle, getWidth, getX, getXMLSafeValue, getXMLSafeValue, getY, hasLinkedGroupWithinLayer, hasProperties, intersects, intersects, intersects, intersects, inverseTransformPoint, isLinked, isLinked, isLinked, isLocked, isLocked2, isOnlyLinkedTo, isOnlyLinkedTo, isOutOfRepaintingClip, isOutOfRepaintingClip, isRoughlyInside, isVisible, link, link, linkPatches, makeAdjustPropertiesDialog, measure, mouseWheelMoved, paintAsBox, paintOffscreen, paintSnapshot, preConcatenate, prePaint, preTransform, processAdjustPropertiesDialog, remove, remove2, removeLinkedProperties, removeLinkedPropertiesFromOrigins, repaint, restXML, rotate, rotate, rotatePoints, scale, scale, scalePoints, setAffineTransform, setAlpha, setAlpha, setAnnotation, setColor, setCompositeMode, setDimensions, setDimensions, setLayer, setLayer, setLinkedProperties, setLinkedProperty, setLocation, setLocked, setProperty, setVisible, setVisible, snapTo, softRemove, transform, transformPoint, transformPoint, transformPoints, transformPoints, transformPoints, transformPoints, transformPoints, transformPoints, transformPoints, transformPoints, transformPoints, transformRectangle, translate, translate, unlink, unlink, unlinkAll, updateBucket, 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
- TEXT
```
public static final int TEXT
```
  See Also:
  
  Constant Field Values
- ARROW
```
public static final int ARROW
```
  See Also:
  
  Constant Field Values
- DOT
```
public static final int DOT
```
  See Also:
  
  Constant Field Values

Constructor Detail

DLabel

public DLabel(Project project,
              String text,
              double x,
              double y)

DLabel

public DLabel(Project project,
              long id,
              String text,
              float width,
              float height,
              int type,
              String font_name,
              int font_style,
              int font_size,
              boolean locked,
              AffineTransform at)

For reconstruction purposes.

DLabel

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

To reconstruct from an XML entry.

Method Detail
- getType
```
public int getType()
```
- getFont
```
public Font getFont()
```
- flush
```
public void flush()
```
- setTitle
```
public void setTitle(String title)
```
  Description copied from class: Displayable
  
  Does not accept null or zero-length titles.
  
  Overrides:
  
  setTitle in class Displayable
- setText
```
public void setText(String title,
                    boolean update)
```
- 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 Displayable
- toString
```
public String toString()
```
  Description copied from class: Displayable
  
  Minimal info that identifies this object as unique, for display on a JTree node.
  
  Overrides:
  
  toString in class Displayable
- setType
```
public void setType(int type)
```
- 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
  
  Overrides:
  
  paint in class Displayable
- getBoundingBox
```
public Rectangle getBoundingBox(Rectangle r)
```
  Saves one allocation, returns the same Rectangle, modified (or a new one if null). This method is overriden so that the x,y, which underlies the text, is translated upward by the height to generate a box that encloses the text and not just sits under it.
  
  Overrides:
  
  getBoundingBox in class Displayable
- getPerimeter
```
public Polygon getPerimeter()
```
  Description copied from class: Displayable
  
  Subclasses can override this method to provide the exact contour, otherwise it returns the transformed bounding box of the data.
  
  Overrides:
  
  getPerimeter in class Displayable
- 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.
  
  Overrides:
  
  getPerimeter in class Displayable
- mousePressed
```
public void mousePressed(MouseEvent me,
                         Layer layer,
                         int x_p,
                         int y_p,
                         double mag)
```
  Overrides:
  
  mousePressed in class Displayable
- 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)
```
  Overrides:
  
  mouseDragged in class Displayable
- 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)
```
  Overrides:
  
  mouseReleased in class Displayable
- isDeletable
```
public boolean isDeletable()
```
  Specified by:
  
  isDeletable in class Displayable
- keyPressed
```
public void keyPressed(KeyEvent ke)
```
  Overrides:
  
  keyPressed in class Displayable
- edit
```
public void edit()
```
- 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(StringBuilder sb_header,
                             HashSet<String> hs,
                             String indent)
```
- adjustProperties
```
public void adjustProperties()
```
  Description copied from class: Displayable
  
  Shows a dialog to adjust properties of this object.
  
  Overrides:
  
  adjustProperties in class Displayable
- clone
```
public DLabel clone(Project pr,
                    boolean copy_id)
```
  Performs a deep copy of this object, except for the Layer pointer.
  
  Specified by:
  
  clone in class Displayable
- apply
```
public boolean apply(Layer la,
                     Area roi,
                     CoordinateTransform ict)
              throws Exception
```
  Description copied from interface: VectorData
  
  Applies the 2D transform @ict (which is expected to operate on the world coordinates version of the data contained here) only to the data that falls within the @param roi (in world coords), and then recomputes the bounding box and affine transform (to a translation or identity). Does not consider links.
  
  Specified by:
  
  apply in interface VectorData
  
  Parameters:
  
  la - Only data at this Layer may be transformed.
  
  roi - Only data inside this world-coordinates Area may be transformed.
  
  ict - The transform to apply to the data that is in @param la and within @param roi.
  
  Throws:
  
  Exception
- apply
```
public boolean apply(VectorDataTransform vdt)
              throws Exception
```
  Specified by:
  
  apply in interface VectorData
  
  Throws:
  
  Exception

Class DLabel

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

TEXT

ARROW

DOT

Constructor Detail

DLabel

DLabel

DLabel

Method Detail

getType

getFont

flush

setTitle

setText

getShortTitle

toString

setType

paint

getBoundingBox

getPerimeter

getPerimeter

mousePressed

mouseDragged

mouseReleased

isDeletable

keyPressed

edit

exportXML

exportDTD

adjustProperties

clone

apply

apply