ProjectFrame (GeOxygene 1.9-SNAPSHOT API)

All Known Implementing Classes:

AbstractProjectFrame, FloatingProjectFrame, TabbedProjectFrame
```
public interface ProjectFrame
```
A projectFrame is a Windowed graphic area contained into a MainFrame and containing some layers to display, a selection, an Sld, ...

Author:

turbet

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addComponentInProjectFrame(JComponent component, String layout)` Add a component to this ProjectFrame
`Layer`	`addFeatureCollection(IPopulation<?> population, String name)` Deprecated. This function should not be longer used since layers include now a CRS. Only here to ensure backward compatibility
`Layer`	`addFeatureCollection(IPopulation<? extends IFeature> population, String name, CoordinateReferenceSystem crs)` Add a feature collection to the project.
`void`	`addGpsTxtLayer(String fileName)`
`void`	`addImage(String name, BufferedImage image, double[][] range)`
`void`	`addLayer(File file)`
`void`	`addLayer(Layer l)` Add a layer at the end of the sld of this ProjectFrame.
`void`	`addLayer(Layer l, int index)` Inserts the specified layer at the specified position in this ProjectFrame.
`void`	`addRoadNetworkTxtLayer(String fileName)`
`void`	`addSldEditionLock(Object owner)`
`Layer`	`addUserLayer(IFeatureCollection<? extends IFeature> collection, String name, CoordinateReferenceSystem crs)` Add a feature collection to the project.
`void`	`askAndAddNewLayer()`
`void`	`clearAllSldEditionOwner()`
`void`	`clearSelection()` Clear the selection.
`void`	`dispose()` Dispose of the frame an its `LayerViewPanel`.
`DataSet`	`getDataSet()`
`JComponent`	`getGui()` get the main GUI component of this Project Frame
`BufferedImage`	`getImage(IFeature feature)`
`Layer`	`getLayer(String name)`
`Layer`	`getLayerFromFeature(IFeature ft)`
`LayerLegendPanel`	`getLayerLegendPanel()`
`List<Layer>`	`getLayers()`
`LayerViewPanel`	`getLayerViewPanel()`
`MainFrame`	`getMainFrame()`
`JMenuBar`	`getMenuBar()`
`String`	`getName()` get project name
`StyledLayerDescriptor`	`getSld()`
`Set<Object>`	`getSldEditionOwners()`
`String`	`getTitle()` get the project frame title
`void`	`loadSLD(File file)` SCH load the described styles in an xml file and apply them to a predefined dataset.
`void`	`loadSLD(StyledLayerDescriptor new_sld, boolean validate)`
`void`	`releaseSldEditionLock(Object owner)` return true if SLD is currently in edition
`void`	`removeLayers(List<Layer> toRemove)`
`void`	`repaint()` repaint UI
`void`	`saveAsImage(String fileName)` Deprecated. Use `saveAsImage(String, int, int, boolean)` instead.
`void`	`saveAsImage(String fileName, int w, int h, boolean doSaveWorldFile)` Save the map into an image file.
`void`	`saveAsShp(String fileName, Layer layer)` Saves a layer into an ESRI Shapefile
`void`	`saveAsSLD(String fileName)` SCH Save the current styles into an xml file.
`void`	`setGeometryToolsVisible(boolean b)`
`void`	`setLocation(int widthProjectFrame, int i)`
`void`	`setMenuBar(JMenuBar menuBar)`
`void`	`setSize(int widthProjectFrame, int i)`
`void`	`setSld(StyledLayerDescriptor sld)`
`void`	`setTitle(String string)` set the project frame title
`void`	`validate()` Validates this container and all of its subcomponents.

- Method Detail
  - getGui
```
JComponent getGui()
```
    get the main GUI component of this Project Frame
  - getMainFrame
```
MainFrame getMainFrame()
```
    Returns:
    
    the main frame containing all project frames
  - getLayerViewPanel
```
LayerViewPanel getLayerViewPanel()
```
    Returns:
    
    The LayerViewPanel
  - setSld
```
void setSld(StyledLayerDescriptor sld)
```
  - getSld
```
StyledLayerDescriptor getSld()
```
    Returns:
    
    The project styled layer descriptor
  - addLayer
```
void addLayer(Layer l)
```
    Add a layer at the end of the sld of this ProjectFrame.
    
    Parameters:
    
    l - the new layer
  - addLayer
```
void addLayer(Layer l,
              int index)
```
    Inserts the specified layer at the specified position in this ProjectFrame.
    
    Parameters:
    
    l - the new layer
    
    index - the position of the new layer
  - addLayer
```
void addLayer(File file)
```
  - askAndAddNewLayer
```
void askAndAddNewLayer()
```
  - addGpsTxtLayer
```
void addGpsTxtLayer(String fileName)
```
  - addRoadNetworkTxtLayer
```
void addRoadNetworkTxtLayer(String fileName)
```
  - addFeatureCollection
```
Layer addFeatureCollection(IPopulation<? extends IFeature> population,
                           String name,
                           CoordinateReferenceSystem crs)
```
    Add a feature collection to the project.
    
    Parameters:
    
    population - the population to add
    
    name - the name of the population
  - addUserLayer
```
Layer addUserLayer(IFeatureCollection<? extends IFeature> collection,
                   String name,
                   CoordinateReferenceSystem crs)
```
    Add a feature collection to the project.
    
    Parameters:
    
    population - the population to add
    
    name - the name of the population
  - addFeatureCollection
```
@Deprecated
Layer addFeatureCollection(IPopulation<?> population,
                                       String name)
```
    Deprecated. This function should not be longer used since layers include now a CRS. Only here to ensure backward compatibility
  - getLayers
```
List<Layer> getLayers()
```
    Returns:
    
    The list of the project's layers
  - dispose
```
void dispose()
```
    Dispose of the frame an its LayerViewPanel.
  - getLayer
```
Layer getLayer(String name)
```
    Parameters:
    
    name - name of the layer
    
    Returns:
    
    The layer with the given name
  - clearSelection
```
void clearSelection()
```
    Clear the selection.
  - getLayerFromFeature
```
Layer getLayerFromFeature(IFeature ft)
```
  - setGeometryToolsVisible
```
void setGeometryToolsVisible(boolean b)
```
  - addImage
```
void addImage(String name,
              BufferedImage image,
              double[][] range)
```
  - getImage
```
BufferedImage getImage(IFeature feature)
```
  - saveAsImage
```
void saveAsImage(String fileName,
                 int w,
                 int h,
                 boolean doSaveWorldFile)
```
    Save the map into an image file. The file format is determined by the given file extension. If there is none or if the given extension is unsupported, the image is saved in PNG format.
    
    Parameters:
    
    fileName - the image file to save into.
    
    doSaveWorldFile -
    
    h - : the height of the image
    
    w - : the width of the image
    
    doSaveWorldFile - : if set to True, save the georeferencing informations in a WorldFile
  - saveAsImage
```
void saveAsImage(String fileName)
```
    Deprecated. Use saveAsImage(String, int, int, boolean) instead.
    
    Save the map into an image file. The file format is determined by the given file extension. If there is none or if the given extension is unsupported, the image is saved in PNG format.
    
    Parameters:
    
    fileName - the image file to save into.
  - saveAsShp
```
void saveAsShp(String fileName,
               Layer layer)
```
    Saves a layer into an ESRI Shapefile
    
    Parameters:
    
    fileName -
    
    layer -
  - saveAsSLD
```
void saveAsSLD(String fileName)
```
    SCH Save the current styles into an xml file.
    
    Parameters:
    
    fileName - the xml file to save into.
  - loadSLD
```
void loadSLD(File file)
      throws FileNotFoundException,
             JAXBException
```
    SCH load the described styles in an xml file and apply them to a predefined dataset.
    
    Parameters:
    
    fileName - the xml file to load.
    
    validate - Enable the validation of the sld elements
    
    Throws:
    
    JAXBException
    
    FileNotFoundException
  - loadSLD
```
void loadSLD(StyledLayerDescriptor new_sld,
             boolean validate)
```
  - removeLayers
```
void removeLayers(List<Layer> toRemove)
```
  - getDataSet
```
DataSet getDataSet()
```
  - repaint
```
void repaint()
```
    repaint UI
  - getLayerLegendPanel
```
LayerLegendPanel getLayerLegendPanel()
```
  - setTitle
```
void setTitle(String string)
```
    set the project frame title
  - getTitle
```
String getTitle()
```
    get the project frame title
  - getName
```
String getName()
```
    get project name
  - setMenuBar
```
void setMenuBar(JMenuBar menuBar)
```
  - getMenuBar
```
JMenuBar getMenuBar()
```
  - setSize
```
void setSize(int widthProjectFrame,
             int i)
```
  - setLocation
```
void setLocation(int widthProjectFrame,
                 int i)
```
  - addComponentInProjectFrame
```
void addComponentInProjectFrame(JComponent component,
                                String layout)
```
    Add a component to this ProjectFrame
  - validate
```
void validate()
```
    Validates this container and all of its subcomponents.
  - releaseSldEditionLock
```
void releaseSldEditionLock(Object owner)
```
    return true if SLD is currently in edition
  - addSldEditionLock
```
void addSldEditionLock(Object owner)
```
  - getSldEditionOwners
```
Set<Object> getSldEditionOwners()
```
  - clearAllSldEditionOwner
```
void clearAllSldEditionOwner()
```

Interface ProjectFrame

Method Summary

Method Detail

getGui

getMainFrame

getLayerViewPanel

setSld

getSld

addLayer

addLayer

addLayer

askAndAddNewLayer

addGpsTxtLayer

addRoadNetworkTxtLayer

addFeatureCollection

addUserLayer

addFeatureCollection

getLayers

dispose

getLayer

clearSelection

getLayerFromFeature

setGeometryToolsVisible

addImage

getImage

saveAsImage

saveAsImage

saveAsShp

saveAsSLD

loadSLD

loadSLD

removeLayers

getDataSet

repaint

getLayerLegendPanel

setTitle

getTitle

getName

setMenuBar

getMenuBar

setSize

setLocation

addComponentInProjectFrame

validate

releaseSldEditionLock

addSldEditionLock

getSldEditionOwners

clearAllSldEditionOwner