org.gvsig.symbology.fmap.mapcontext.rendering.symbol.style

Class BackgroundFileStyle

java.lang.Object

org.gvsig.symbology.fmap.mapcontext.rendering.symbol.style.AbstractStyle

org.gvsig.symbology.fmap.mapcontext.rendering.symbol.style.BackgroundFileStyle

All Implemented Interfaces:

java.lang.Cloneable, IBackgroundFileStyle, IStyle, Persistent

Direct Known Subclasses:

ImageStyle, RemoteFileStyle, SVGStyle

public abstract class BackgroundFileStyle
extends AbstractStyle
implements IBackgroundFileStyle

Defines methods that allows the user to create an style based in a background file.For this reason, BackgroundFileStyle will have a parameter that will be an string in order to specify this source file.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	BackgroundFileStyle.PersistenceCantSetSourceException
static class	BackgroundFileStyle.RegisterPersistence

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BACKGROUND_FILE_STYLE_PERSISTENCE_DEFINITION_NAME
protected java.net.URL	source
protected static java.lang.String	SOURCE_SYMBOL_IN_LIBRARY

Fields inherited from class org.gvsig.symbology.fmap.mapcontext.rendering.symbol.style.AbstractStyle

STYLE_PERSISTENCE_DEFINITION_NAME

Constructor Summary

Constructors

Constructor and Description
BackgroundFileStyle()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	clone() Creates a copy of the object.
static BackgroundFileStyle	createStyleByURL(java.net.URL url)
void	drawInsideRectangle(java.awt.Graphics2D g, java.awt.Rectangle r) Useful to render the symbol inside the TOC, or inside little rectangles.
abstract void	drawInsideRectangle(java.awt.Graphics2D g, java.awt.Rectangle r, boolean keepAspectRatio)
abstract java.awt.Rectangle	getBounds() Gets the bounding Rectangle of this Rectangle.
java.net.URL	getSource() Obtains the source of the file which is used to create the background
protected java.lang.String	getSourceSymbolInLibrary() Return the final substring of the URL symbol in the library
protected java.net.URL	getSymbolLibraryURL()
protected boolean	isLibrarySymbol()
abstract void	setSource(java.net.URL url) Sets the file that is used as a source to create the Background

Methods inherited from class org.gvsig.symbology.fmap.mapcontext.rendering.symbol.style.AbstractStyle

getDescription, loadFromState, saveToState, setDescription

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.gvsig.fmap.mapcontext.rendering.symbols.styles.IStyle

drawOutline, getDescription, isSuitableFor, setDescription

Methods inherited from interface org.gvsig.tools.persistence.Persistent

loadFromState, saveToState

Field Detail

BACKGROUND_FILE_STYLE_PERSISTENCE_DEFINITION_NAME

public static final java.lang.String BACKGROUND_FILE_STYLE_PERSISTENCE_DEFINITION_NAME

See Also:

Constant Field Values

SOURCE_SYMBOL_IN_LIBRARY

protected static final java.lang.String SOURCE_SYMBOL_IN_LIBRARY

See Also:

Constant Field Values

source

protected java.net.URL source

Constructor Detail

BackgroundFileStyle

public BackgroundFileStyle()

Method Detail

createStyleByURL

public static BackgroundFileStyle createStyleByURL(java.net.URL url)
                                            throws java.io.IOException

Throws:

java.io.IOException

setSource

public abstract void setSource(java.net.URL url)
                        throws java.io.IOException

Sets the file that is used as a source to create the Background

Specified by:

setSource in interface IBackgroundFileStyle

Parameters:

f, - File

Throws:

java.io.IOException

getBounds

public abstract java.awt.Rectangle getBounds()

Gets the bounding Rectangle of this Rectangle.

This method is included for completeness, to parallel the getBounds method of Component.

Specified by:

getBounds in interface IBackgroundFileStyle

Returns:

a new Rectangle, equal to the bounding Rectangle for this Rectangle.

Since:

JDK1.1

See Also:

Component.getBounds(), #setBounds(Rectangle), #setBounds(int, int, int, int)

getSource

public final java.net.URL getSource()

Obtains the source of the file which is used to create the background

Specified by:

getSource in interface IBackgroundFileStyle

Returns:

drawInsideRectangle

public final void drawInsideRectangle(java.awt.Graphics2D g,
                       java.awt.Rectangle r)
                               throws SymbolDrawingException

Description copied from interface: IStyle

Useful to render the symbol inside the TOC, or inside little rectangles. For example, think about rendering a Label with size in meters => You will need to specify a size in pixels. Of course. You may also preffer to render a prepared image, etc.

Specified by:

drawInsideRectangle in interface IStyle

Parameters:

g - Graphics2D

r - Rectangle

Throws:

SymbolDrawingException

drawInsideRectangle

public abstract void drawInsideRectangle(java.awt.Graphics2D g,
                       java.awt.Rectangle r,
                       boolean keepAspectRatio)
                                  throws SymbolDrawingException

Throws:

SymbolDrawingException

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Description copied from interface: Cloneable

Creates a copy of the object.

Overrides:

clone in class AbstractStyle

Returns:

a copy of the object

Throws:

java.lang.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.

See Also:

Object#clone()}.

isLibrarySymbol

protected boolean isLibrarySymbol()

getSymbolLibraryURL

protected java.net.URL getSymbolLibraryURL()

getSourceSymbolInLibrary

protected java.lang.String getSourceSymbolInLibrary()

Return the final substring of the URL symbol in the library

Returns: