public class LabelClass extends Object implements ILabelClass
Modifier and Type | Class and Description |
---|---|
static class |
LabelClass.RegisterPersistence |
PAPER, WORLD
Constructor and Description |
---|
LabelClass() |
Modifier and Type | Method and Description |
---|---|
Object |
clone()
Creates a copy of the object.
|
void |
draw(Graphics2D graphics,
ILabelLocationMetrics llm,
Geometry geom)
LabelLocationMetrics, contains the anchor point, rotation, and some
other geometric calculations computed by the PlacementManager.
|
void |
drawInsideRectangle(Graphics2D graphics,
Rectangle bounds)
Useful to render a Label with size inside little rectangles.
|
Rectangle |
getBounds() |
double |
getCartographicSize(ViewPort viewPort,
double dpi,
Geometry geom)
Gets the size (in pixels) of the cartographic element according
to the current rendering context (output dpi, map scale, map units) and the
symbol cartgraphic settings (unit, size, and unit reference system).
|
String |
getClassName() |
String[] |
getLabelExpressions()
Returns the expression that defines the text which will be showed in
the label
|
ILabelStyle |
getLabelStyle()
Returns the style of the label
|
String |
getName()
Returns the name of the label
|
int |
getPriority() |
int |
getReferenceSystem()
Returns the Reference System used to draw the elements of the image.
|
Geometry |
getShape(ILabelLocationMetrics llm) |
String |
getSQLQuery() |
String |
getStringLabelExpression()
Returns the expression that defines the text which will be showed in
the label ready to be used for the label parser
|
String[] |
getTexts()
Return the text for the label
|
ITextSymbol |
getTextSymbol()
Returns the text symbol that is being used for the text(the font,
size,style,aligment)
|
int |
getUnit()
Returns the unit used to express measures.
|
boolean |
isUseSqlQuery() |
boolean |
isVisible()
Returns true if the label will be showed in the map
|
boolean |
isVisible(double scale)
Returns true if the label will be showed in the map
|
void |
loadFromState(PersistentState state)
Set the state of the object from the state passed as parameter.
|
void |
saveToState(PersistentState state)
Saves the internal state of the object on the provided
PersistentState object.
|
void |
setCartographicSize(double cartographicSize,
Geometry geom)
Sets the size of the cartographic element in pixels.
|
void |
setLabelExpressions(String[] lbl_exps)
Stablishes the expresion that, when it is evaluated, returns the text
which will be showed by the label.
|
void |
setLabelStyle(ILabelStyle labelStyle)
Stablishes the style for the label.
|
void |
setName(String name)
Stablishes the name of the label
|
void |
setPriority(int priority) |
void |
setReferenceSystem(int referenceSystem)
Sets the Reference System that defines how this units have to be
handled.
|
void |
setSQLQuery(String sqlQuery) |
void |
setTexts(String[] texts)
Sets the text for the label
|
void |
setTextSymbol(ITextSymbol textSymbol)
Stablishes the text symbol that is going to be used for the text(the
font,size,style,aligment)
|
void |
setUnit(int unitIndex)
Defines the unit used to express measures.
|
void |
setUseSqlQuery(boolean use_sql) |
void |
setVisible(boolean isVisible)
Sets the visibility of the label in the map.
|
double |
toCartographicSize(ViewPort viewPort,
double dpi,
Geometry geom)
Computes and sets the size (in pixels) of the cartographic element according
to the current rendering context (output dpi, map scale, map units) and the
symbol cartgraphic settings (unit, size, and unit reference system).
|
String |
toString() |
public boolean isVisible()
isVisible
in interface ILabelClass
public boolean isVisible(double scale)
isVisible
in interface ILabelClass
public void setVisible(boolean isVisible)
setVisible
in interface ILabelClass
isVisible
- booleanpublic String[] getLabelExpressions()
getLabelExpressions
in interface ILabelClass
public void setLabelExpressions(String[] lbl_exps)
setLabelExpressions
in interface ILabelClass
labelExpression
- Stringpublic ITextSymbol getTextSymbol()
getTextSymbol
in interface ILabelClass
public void setTextSymbol(ITextSymbol textSymbol)
setTextSymbol
in interface ILabelClass
textSymbol
- ITextSymbolpublic void setLabelStyle(ILabelStyle labelStyle)
setLabelStyle
in interface ILabelClass
labelStyle
- ILabelStylepublic ILabelStyle getLabelStyle()
getLabelStyle
in interface ILabelClass
public String getName()
getName
in interface ILabelClass
public void setName(String name)
setName
in interface ILabelClass
name
- public String toString()
toString
in interface ILabelClass
toString
in class Object
public void setTexts(String[] texts)
setTexts
in interface ILabelClass
texts
- String[]public String[] getTexts()
getTexts
in interface ILabelClass
texts
- String[]public void draw(Graphics2D graphics, ILabelLocationMetrics llm, Geometry geom)
LabelLocationMetrics, contains the anchor point, rotation, and some other geometric calculations computed by the PlacementManager.
The shp argument is passed as an accessory for subclasses of this class in case they need futher geometric calculations
draw
in interface ILabelClass
graphics,
- graphics to use to paint the label.llm,
- concrete settings of the placement of this layershp,
- the Shape over whose the label is paintedpublic void drawInsideRectangle(Graphics2D graphics, Rectangle bounds) throws SymbolDrawingException
drawInsideRectangle
in interface ILabelClass
graphics
- Graphics2Dbounds
- RectangleSymbolDrawingException
public int getPriority()
getPriority
in interface ILabelClass
public void setPriority(int priority)
setPriority
in interface ILabelClass
public Geometry getShape(ILabelLocationMetrics llm) throws CreateGeometryException
getShape
in interface ILabelClass
CreateGeometryException
public String getClassName()
getClassName
in interface ILabelClass
public double getCartographicSize(ViewPort viewPort, double dpi, Geometry geom)
CartographicSupport
getCartographicSize
in interface ILabelClass
getCartographicSize
in interface CartographicSupport
public int getReferenceSystem()
CartographicSupport
The elements have to be scaled to pixel when the image is bein drawn in
order to compose the map. The elements of the map may define its size in
other units than pixel.
CartographicSupport enables the elements to define the size in
measure units but these units may refer to different reference system. Two
kinds of Reference Systems are allowed in this context: CartographicSupport.WORLD,
and CartographicSupport.PAPER.
Depending on which Reference System is used the unit used by this element
refers to distances in the real world (then they are map's CRS-dependant)
or screen or printer output (then they are output DPI-dependant)
In case the unit used is pixel then the reference system does not
have any effect since the source unit is the same than the target unit.
getReferenceSystem
in interface ILabelClass
getReferenceSystem
in interface CartographicSupport
public int getUnit()
CartographicSupport
getUnit
in interface ILabelClass
getUnit
in interface CartographicSupport
public void setCartographicSize(double cartographicSize, Geometry geom)
CartographicSupport
setCartographicSize
in interface ILabelClass
setCartographicSize
in interface CartographicSupport
public void setReferenceSystem(int referenceSystem)
CartographicSupport
setReferenceSystem
in interface ILabelClass
setReferenceSystem
in interface CartographicSupport
public void setUnit(int unitIndex)
CartographicSupport
setUnit
in interface ILabelClass
setUnit
in interface CartographicSupport
public double toCartographicSize(ViewPort viewPort, double dpi, Geometry geom)
CartographicSupport
toCartographicSize
in interface ILabelClass
toCartographicSize
in interface CartographicSupport
public Rectangle getBounds()
getBounds
in interface ILabelClass
public String getSQLQuery()
getSQLQuery
in interface ILabelClass
public void setSQLQuery(String sqlQuery)
setSQLQuery
in interface ILabelClass
public void saveToState(PersistentState state) throws PersistenceException
Persistent
saveToState
in interface Persistent
PersistenceException
public void loadFromState(PersistentState state) throws PersistenceException
Persistent
loadFromState
in interface Persistent
PersistenceException
public void setUseSqlQuery(boolean use_sql)
setUseSqlQuery
in interface ILabelClass
public boolean isUseSqlQuery()
isUseSqlQuery
in interface ILabelClass
public String getStringLabelExpression()
ILabelClass
getStringLabelExpression
in interface ILabelClass
public Object clone() throws CloneNotSupportedException
Cloneable
clone
in class Object
CloneNotSupportedException
- if the instance of the object cannot
be cloned. As this is extending Cloneable
so
its sure it implements it, so this exception may be used for problems
on specific object instances.Object#clone()}.