DK11 for Java | tatukgis.jdk.TGIS_ConfigIni | Classes | Constructors | Fields | Methods | Properties
Encapsulation of layer configuration file.
// Java public class TGIS_ConfigIni extends TGIS_Config { };
// Oxygene type TGIS_ConfigIni = public class( TGIS_Config ) end;
→ TGIS_BaseObjectDisposable → TGIS_ConfigAbstract → TGIS_Config
Name | Visibility | Description | |
---|---|---|---|
TGIS_ConfigIni() | public | Create instance. (Overrides TGIS_Config.TGIS_Config()) |
|
Name | Visibility | Description | |
---|---|---|---|
FConfigFormat | protected | Actual config format. (Inherited from TGIS_Config) |
|
FConfigPath | protected | Path for config file. (Inherited from TGIS_Config) |
|
FMustSave | protected | True if config should be saved. (Inherited from TGIS_Config) |
|
FVersion | protected | Config version number. (Inherited from TGIS_Config) |
|
Name | Visibility | Description | |
---|---|---|---|
AbsolutePath | public | Computes absolute path for path relative to configuration file. (Inherited from TGIS_Config) |
|
AddSubLayer | public | Add sublayer to config file. (Overrides TGIS_Config.AddSubLayer) |
|
buildGroupParamList | protected | Build parameters list. | |
buildParamList | protected | Build parameters list. | |
BuildProject | public | Build project file based on current project and list of layers attached to the Viewer. (Inherited from TGIS_Config) |
|
buildSubParamList | protected | Build parameters list. | |
ClearActiveSection | public | Delete elements related to the current section. (Overrides TGIS_Config.ClearActiveSection) |
|
ClearGroups | public | Delete group sections related to the selected group. (Overrides TGIS_Config.ClearGroups) |
|
ClearSave | public | Clear MustSave flag. (Inherited from TGIS_Config) |
|
ClearSections | public | Delete sections related to the selected layer. (Overrides TGIS_Config.ClearSections) |
|
ClearSubSections | public | Delete subsections related to the selected layer. (Overrides TGIS_Config.ClearSubSections) |
|
clearZones | protected | Clear zones list. (Overrides TGIS_Config.clearZones) |
|
getGroupNo | protected | Read from project configuration file a stored number (#) of the layer corresponding to a given name. | |
getGroupSectionName | protected | Computes a section name based on the layer number and the number of the zoom section. | |
getLayerNo | protected | Read from project configuration file a stored number (#) of the layer corresponding to a given name. | |
getSectionName | protected | Computes a section name based on the layer number and the number of the zoom section. | |
GetStrings | public | Parse and fill list with values. (Overrides TGIS_Config.GetStrings) |
|
getSubLayerNo | protected | Read from project configuration file a stored number (#) of the layer corresponding to a given name. | |
getSubSectionName | protected | Computes a section name based on the layer number and the number of the zoom section. | |
Lock | public | Lock configuration file. (Overrides TGIS_Config.Lock) |
|
Read3DLayerType | public | Read parameters given by _name. (Inherited from TGIS_Config) |
|
ReadAlignment | public | Read parameters given by _name. (Inherited from TGIS_Config) |
|
ReadBasement | public | Read parameters given by _name. (Inherited from TGIS_Config) |
|
ReadBitmap | public | Read parameters given by _name. (Inherited from TGIS_Config) |
|
ReadBoolean | public | Read parameters given by _name. (Inherited from TGIS_Config) |
|
ReadChart | public | Read parameters given by _name. (Inherited from TGIS_Config) |
|
ReadColor | public | Read parameters given by _name. (Inherited from TGIS_Config) |
|
ReadColorInterpolationMode | public | Read parameters given by _name. (Inherited from TGIS_Config) |
|
ReadColorRamp | public | Read color ramp parameter given by _name. (Inherited from TGIS_Config) |
|
ReadCustomData | public | Read custom configuration parameters. (Inherited from TGIS_Config) |
|
readCustomParam | protected | Read custom configuration parameters. (Overrides TGIS_Config.readCustomParam) |
|
ReadDormant | public | Read parameters given by _name. (Inherited from TGIS_Config) |
|
ReadFloat | public | Read parameters given by _name. (Inherited from TGIS_Config) |
|
ReadFontStyle | public | Read parameters given by _name. (Inherited from TGIS_Config) |
|
ReadGround | public | Read parameters given by _name. (Inherited from TGIS_Config) |
|
ReadHierarchyGroups | public | Read hierarchy groups to config. (Inherited from TGIS_Config) |
|
ReadInteger | public | Read parameters given by _name. (Inherited from TGIS_Config) |
|
ReadInterpretation | public | Read parameters given by _name. (Inherited from TGIS_Config) |
|
ReadMarker | public | Read parameters given by _name. (Inherited from TGIS_Config) |
|
ReadNormalized | public | Read parameters given by _name. (Inherited from TGIS_Config) |
|
ReadOffsetPosition | public | Read parameters given by _name. (Inherited from TGIS_Config) |
|
readParam | protected | Read configuration parameter from list prepared by buildParamList. (Overrides TGIS_Config.readParam) |
|
ReadPattern | public | Read parameters given by _name. (Inherited from TGIS_Config) |
|
ReadPen | public | Read parameters given by _name. (Inherited from TGIS_Config) |
|
ReadPosition | public | Read parameters given by _name. (Inherited from TGIS_Config) |
|
ReadSectionValues | public | Read section values into a list. (Overrides TGIS_Config.ReadSectionValues) |
|
ReadString | public | Read parameters given by _name. (Inherited from TGIS_Config) |
|
ReadSymbol | public | Read parameters given by _name. (Inherited from TGIS_Config) |
|
ReadZone | public | Read parameters given by zone _name. (Inherited from TGIS_Config) |
|
readZones | protected | Read zones to list. (Overrides TGIS_Config.readZones) |
|
RelativePath | public | Computes path relative to configuration file. (Inherited from TGIS_Config) |
|
Reread | public | Reread configuration file. (Overrides TGIS_Config.Reread) |
|
Save | public | Save backup copy of configuration file. (Overrides TGIS_Config.Save) |
|
SetGroup | public | Select layer on which the operation will be performed. (Overrides TGIS_Config.SetGroup) |
|
SetGroupSection | public | Select the group section on which the operation will be performed. (Overrides TGIS_Config.SetGroupSection) |
|
SetLayer | public | Select layer on which the operation will be performed. (Overrides TGIS_Config.SetLayer) |
|
SetSection | public | Select the section on which the operation will be performed. (Overrides TGIS_Config.SetSection) |
|
SetStrings | public | Read and parse values from list. (Overrides TGIS_Config.SetStrings) |
|
SetSubLayer | public | Select sublayer on which the operation will be performed. (Overrides TGIS_Config.SetSubLayer) |
|
SetSubSection | public | Select the subsection on which the operation will be performed. (Overrides TGIS_Config.SetSubSection) |
|
Unlock | public | Unlock configuration file. (Overrides TGIS_Config.Unlock) |
|
Write3DLayerType | public | Write parameters given by _name. (Inherited from TGIS_Config) |
|
WriteAlignment | public | Write parameters given by _name. (Inherited from TGIS_Config) |
|
WriteBasement | public | Write parameters given by _name. (Inherited from TGIS_Config) |
|
WriteBitmap | public | Write parameters given by _name. (Inherited from TGIS_Config) |
|
WriteBoolean | public | Write parameters given by _name. (Inherited from TGIS_Config) |
|
WriteChart | public | Write parameters given by _name. (Inherited from TGIS_Config) |
|
WriteColor | public | Write parameters given by _name. (Inherited from TGIS_Config) |
|
WriteColorInterpolationMode | public | Write parameters given by _name. (Inherited from TGIS_Config) |
|
WriteColorRamp | public | Write color ramp parameter given by _name. (Inherited from TGIS_Config) |
|
WriteCustomData | public | Write custom configuration parameters. (Inherited from TGIS_Config) |
|
writeCustomParam | protected | Write custom configuration parameters. (Overrides TGIS_Config.writeCustomParam) |
|
WriteDormant | public | Write parameters given by _name. (Inherited from TGIS_Config) |
|
WriteFloat | public | Write parameters given by _name. (Inherited from TGIS_Config) |
|
WriteFontStyle | public | Write parameters given by _name. (Inherited from TGIS_Config) |
|
WriteGround | public | Write parameters given by _name. (Inherited from TGIS_Config) |
|
WriteHierarchyGroups | public | Write hierarchy groups to config. (Inherited from TGIS_Config) |
|
WriteInteger | public | Write parameters given by _name. (Inherited from TGIS_Config) |
|
WriteInterpretation | public | Write parameters given by _name. (Inherited from TGIS_Config) |
|
WriteMarker | public | Write parameters given by _name. (Inherited from TGIS_Config) |
|
WriteNormalized | public | Write parameters given by _name. (Inherited from TGIS_Config) |
|
WriteOffsetPosition | public | Write parameters given by _name. (Inherited from TGIS_Config) |
|
writeParam | protected | Write configuration parameter to the configuration file. (Overrides TGIS_Config.writeParam) |
|
WritePattern | public | Write parameters given by _name. (Inherited from TGIS_Config) |
|
WritePen | public | Write parameters given by _name. (Inherited from TGIS_Config) |
|
WritePosition | public | Write parameters given by _name. (Inherited from TGIS_Config) |
|
WriteString | public | Write parameters given by _name. (Inherited from TGIS_Config) |
|
WriteStyle | public | Write parameters given by _name. (Inherited from TGIS_Config) |
|
WriteSymbol | public | Write parameters given by _name. (Inherited from TGIS_Config) |
|
WriteZone | public | Write parameters given by zone _name. (Inherited from TGIS_Config) |
|
writeZones | protected | Write zones from list. (Overrides TGIS_Config.writeZones) |
|
Name | Visibility | Description | |
---|---|---|---|
ConfigFormat | public | Internal format of config. (Inherited from TGIS_Config) |
|
FileName | public | Name of configuration file. (Inherited from TGIS_Config) |
|
IniObj | public | Underlying ini file. | |
IsProject | public | True if config file is a project. (Inherited from TGIS_Config) |
|
IsShapeStyle | public | True if config is for shape style embedding. (Inherited from TGIS_Config) |
|
MustSave | public | True if config file was changed. (Inherited from TGIS_Config) |
|
PrjLayerConfig | public | Config file name (without extension) at a given index in a project file. (Inherited from TGIS_Config) |
|
PrjLayerName | public | Name of layer at a given index in a project file. (Inherited from TGIS_Config) |
|
PrjLayerPath | public | Path of layer at a given index in a project file. (Inherited from TGIS_Config) |
|
PrjLayersCount | public | Returns the number of layers defined in project config file. (Inherited from TGIS_Config) |
|
Section | public | By assigning this value you are overriding default TGIS_Config behavior. (Inherited from TGIS_Config) |
|
UseRelativePath | public | If True (default) all paths will be save as relative to a config file localization. (Inherited from TGIS_Config) |
|
Version | public | Config version number (Inherited from TGIS_Config) |
|
WriteFull | public | If True (default) then all config keys will be saved, otherwise only changed. (Inherited from TGIS_Config) |
|
Procedures to read project and layer configuration files.
1) Layer configuration file
Each layer can have its own configuration file located in the same directory as the layer data itself. This file must have the name “layerfile_with_extension.ini”. Below you can see a sample file with comments:
[TatukGIS Layer] ; this is a general section use common values here Visible=False LineColor=BLACK LineWidth=-2 [TatukGIS Layer 1] ; this is a section valid only for selected zooms MinZoom=0.123 ; this describes when this section will be valid MaxZoom=2.13 ;override standard values Visible=True LineColor=YELLOW [TatukGIS Layer 2] MinZoom=2.13 MaxZoom=999 Visible=True LineColor=YELLOW LineWidth=-5
1A) Renderer
By attaching a 'render' entry followed by a query, you can on/off section:
[TatukGIS Layer 2] MinZoom=2.13 MaxZoom=999 Render=population > 100 Visible=True LineColor=YELLOW LineWidth=-5
First section which meets all criteria will be used. If Render was used, then MinZoom, MaxZoom can be omitted.
1B) Styles.
By attaching style name to a section name we have an option to define special styles (for flushing etc).
[TatukGIS Layer] Style=Flush LineColor=YELLOW LineWidth=-15
2) Project configuration file.
Is very similar to layer configuration file. Values written to this file will overwrite values from layer configuration file.
[TatukGIS Layer1] ;first layer Path=c:\test\street.shp Name=Street ; can be set here or will be read from layer conf. file LineColor=YELLOW [TatukGIS Layer2] ;second layer Path=c:\test\photo.tif Name=Satelite photo [TatukGIS Layer2 1] ; and now first zoom dependent value for second layer MinZoom=1.23 MaxZoom=1.99 Visible=False