ViewProperties (HDFView 2.14)

Object
- Dictionary<K,V>
- - Hashtable<Object,Object>
  - - Properties
    - - hdf.view.ViewProperties

All Implemented Interfaces:

Serializable, Cloneable, Map<Object,Object>
```
public class ViewProperties
extends Properties
```
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ViewProperties.BITMASK_OP` Property keys control how the data is displayed.
`static class`	`ViewProperties.DATA_VIEW_KEY` Property keys control how the data is displayed.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`DELIMITER_COLON` name of the tab delimiter
`static String`	`DELIMITER_COMMA` name of the tab delimiter
`static String`	`DELIMITER_SEMI_COLON` name of the tab delimiter
`static String`	`DELIMITER_SPACE` name of the tab delimiter
`static String`	`DELIMITER_TAB` name of the tab delimiter
`static int`	`MAX_RECENT_FILES` the maximum number of most recent files
`static String`	`ORIGIN_LL` image origin: LowerLeft
`static String`	`ORIGIN_LR` image origin: LowerRight
`static String`	`ORIGIN_UL` image origin: UpperLeft
`static String`	`ORIGIN_UR` image origin: UpperRight
`static String`	`VERSION` the version of the HDFViewer

Fields inherited from class Properties
defaults

Constructor Summary

Constructors
Constructor and Description

ViewProperties(String viewRoot)
Creates a property list with given root directory of the HDFView.

Constructors
Constructor and Description
`ViewProperties(String viewRoot)` Creates a property list with given root directory of the HDFView.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Icon`	`getAnimationIcon()`
`static ImageIcon`	`getAppsIcon()`
`static ImageIcon`	`getAudioIcon()`
`static Icon`	`getAutocontrastIcon()`
`static Icon`	`getBlankIcon()`
`static Icon`	`getBrightIcon()`
`static Icon`	`getChartIcon()`
`static Icon`	`getCopyIcon()`
`static Icon`	`getCutIcon()`
`static String`	`getDataDelimiter()`
`static Icon`	`getDatasetIcon()`
`static Icon`	`getDatasetIconA()`
`static Icon`	`getDatatypeIcon()`
`static Icon`	`getDatatypeIconA()`
`static Icon`	`getFilecloseIcon()`
`static String`	`getFileExtension()`
`static Icon`	`getFilenewIcon()`
`static Icon`	`getFileopenIcon()`
`static Icon`	`getFilesaveIcon()`
`static Icon`	`getFirstIcon()`
`static Icon`	`getFoldercloseIcon()`
`static Icon`	`getFoldercloseIconA()`
`static Icon`	`getFolderopenIcon()`
`static Icon`	`getFolderopenIconA()`
`static int`	`getFontSize()`
`static String`	`getFontType()`
`static Icon`	`getH4Icon()`
`static Icon`	`getH4IconR()`
`static String`	`getH4toH5()`
`static Icon`	`getH5Icon()`
`static Icon`	`getH5IconR()`
`static Icon`	`getHdfIcon()`
`static Icon`	`getHelpIcon()`
`static Vector<String>`	`getHelpViewList()`
`static Icon`	`getImageIcon()`
`static Icon`	`getImageIconA()`
`static String`	`getImageOrigin()`
`static Vector<String>`	`getImageViewList()`
`static String`	`getIndexOrder()`
`static String`	`getIndexType()`
`static Icon`	`getLargeHdfIcon()`
`static Icon`	`getLastIcon()`
`static Icon`	`getLinkIcon()`
`static int`	`getMaxMembers()` Current Java applications such as HDFView cannot handle files with large number of objects such as 1,000,000 objects.
`static int`	`getMaxRecentFiles()`
`static Vector<String>`	`getMetaDataViewList()`
`static Vector<String>`	`getMRF()`
`static Icon`	`getNextIcon()`
`static Icon`	`getPaletteIcon()`
`static Vector<String>`	`getPaletteList()`
`static Vector<String>`	`getPaletteViewList()`
`static Icon`	`getPasteIcon()`
`static ImageIcon`	`getPdfIcon()`
`static Icon`	`getPreviousIcon()`
`static String`	`getPropertyFile()`
`static Icon`	`getQuestionIcon()`
`static Vector<String[]>`	`getSrbAccount()`
`static int`	`getStartMembers()` Current Java applications such as HDFView cannot handle files with large number of objects such as 1,000,000 objects.
`static Icon`	`getTableIcon()`
`static Icon`	`getTableIconA()`
`static Vector<String>`	`getTableViewList()`
`static Icon`	`getTextIcon()`
`static Icon`	`getTextIconA()`
`static Vector<String>`	`getTextViewList()`
`static Vector<String>`	`getTreeViewList()`
`static ImageIcon`	`getUrlIcon()`
`static String`	`getUsersGuide()`
`static ImageIcon`	`getVideoIcon()`
`static String`	`getViewRoot()`
`static String`	`getWorkDir()`
`static ImageIcon`	`getXlsIcon()`
`static Icon`	`getZoominIcon()`
`static Icon`	`getZoomoutIcon()`
`static boolean`	`isAutoContrast()` Returns true if auto contrast is used in image processing.
`static boolean`	`isConvertEnum()`
`static boolean`	`isEarlyLib()` Returns true if default lib version is the earliest.
`static boolean`	`isIndexBase1()`
`static boolean`	`isReadOnly()` Returns true if default file access is read only.
`Enumeration<Object>`	`keys()`
`void`	`load()` Load user properties from property file
`static ClassLoader`	`loadExtClass()` load module classes
`static void`	`loadIcons()`
`void`	`save()` Save user properties into property file
`static void`	`setAutoContrast(boolean b)` Set the flag to indicate if auto contrast is used in image process.
`static void`	`setConvertEnum(boolean convertEnum)`
`static void`	`setDataDelimiter(String delim)` set the delimiter of data values
`static void`	`setEarlyLib(boolean b)` Set the flag to indicate if default lib version is the earliest.
`static void`	`setFileExtension(String ext)` set the file extension
`static void`	`setFontSize(int fsize)` sets the font size
`static void`	`setFontType(String ftype)` sets the font type
`static void`	`setH4toH5(String tool)` set the path of the H4 to H5 converter
`static void`	`setImageOrigin(String o)` set the image origin
`static void`	`setIndexBase1(boolean b)` Set the flag to indicate if IndexBase should start at 1.
`static void`	`setIndexOrder(String idxOrder)` set the index order
`static void`	`setIndexType(String idxType)` set the index type
`static void`	`setMaxMembers(int n)` Current Java applications such as HDFView cannot handle files with large number of objects such as 1,000,000 objects.
`static void`	`setReadOnly(boolean b)` Set the flag to indicate if default file access is read only.
`static void`	`setShowImageValue(boolean b)` Set the flag to indicate if "show image values" is set.
`static void`	`setShowRegRefValue(boolean b)` Set the flag to indicate if "show RegRef values" is set.
`static void`	`setStartMembers(int idx)` Current Java applications such as HDFView cannot handle files with large number of objects such as 1,000,000 objects.
`static void`	`setUsersGuide(String str)` set the path of H5View User's guide
`static void`	`setWorkDir(String wDir)` set the path of the default work directory
`static boolean`	`showImageValues()` Returns true if "show image values" is set.
`static boolean`	`showRegRefValues()` Returns true if "show regref values" is set.

Methods inherited from class Properties
getProperty, getProperty, list, list, load, load, loadFromXML, propertyNames, save, setProperty, store, store, storeToXML, storeToXML, stringPropertyNames

Methods inherited from class Hashtable
clear, clone, compute, computeIfAbsent, computeIfPresent, contains, containsKey, containsValue, elements, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, rehash, remove, remove, replace, replace, replaceAll, size, toString, values

Methods inherited from class Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - VERSION
```
public static final String VERSION
```
    the version of the HDFViewer
    
    See Also:
    
    Constant Field Values
  - MAX_RECENT_FILES
```
public static final int MAX_RECENT_FILES
```
    the maximum number of most recent files
    
    See Also:
    
    Constant Field Values
  - DELIMITER_TAB
```
public static final String DELIMITER_TAB
```
    name of the tab delimiter
    
    See Also:
    
    Constant Field Values
  - DELIMITER_COMMA
```
public static final String DELIMITER_COMMA
```
    name of the tab delimiter
    
    See Also:
    
    Constant Field Values
  - DELIMITER_SPACE
```
public static final String DELIMITER_SPACE
```
    name of the tab delimiter
    
    See Also:
    
    Constant Field Values
  - DELIMITER_COLON
```
public static final String DELIMITER_COLON
```
    name of the tab delimiter
    
    See Also:
    
    Constant Field Values
  - ORIGIN_UL
```
public static final String ORIGIN_UL
```
    image origin: UpperLeft
    
    See Also:
    
    Constant Field Values
  - ORIGIN_LL
```
public static final String ORIGIN_LL
```
    image origin: LowerLeft
    
    See Also:
    
    Constant Field Values
  - ORIGIN_UR
```
public static final String ORIGIN_UR
```
    image origin: UpperRight
    
    See Also:
    
    Constant Field Values
  - ORIGIN_LR
```
public static final String ORIGIN_LR
```
    image origin: LowerRight
    
    See Also:
    
    Constant Field Values
  - DELIMITER_SEMI_COLON
```
public static final String DELIMITER_SEMI_COLON
```
    name of the tab delimiter
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ViewProperties
```
public ViewProperties(String viewRoot)
```
    Creates a property list with given root directory of the HDFView.
    
    Parameters:
    
    viewRoot - the root directory of the HDFView
- Method Detail
  - keys
```
public Enumeration<Object> keys()
```
    Overrides:
    
    keys in class Hashtable<Object,Object>
  - loadExtClass
```
public static ClassLoader loadExtClass()
```
    load module classes
    
    Returns:
    
    the ClassLoader
  - getViewRoot
```
public static String getViewRoot()
```
    Returns:
    
    the root directory where the HDFView is installed.
  - getFoldercloseIcon
```
public static Icon getFoldercloseIcon()
```
  - getFoldercloseIconA
```
public static Icon getFoldercloseIconA()
```
  - getFolderopenIcon
```
public static Icon getFolderopenIcon()
```
  - getFolderopenIconA
```
public static Icon getFolderopenIconA()
```
  - getHdfIcon
```
public static Icon getHdfIcon()
```
  - getH4Icon
```
public static Icon getH4Icon()
```
  - getH4IconR
```
public static Icon getH4IconR()
```
  - getH5Icon
```
public static Icon getH5Icon()
```
  - getH5IconR
```
public static Icon getH5IconR()
```
  - getDatasetIcon
```
public static Icon getDatasetIcon()
```
  - getDatasetIconA
```
public static Icon getDatasetIconA()
```
  - getDatatypeIcon
```
public static Icon getDatatypeIcon()
```
  - getDatatypeIconA
```
public static Icon getDatatypeIconA()
```
  - getLinkIcon
```
public static Icon getLinkIcon()
```
  - getFileopenIcon
```
public static Icon getFileopenIcon()
```
  - getFilesaveIcon
```
public static Icon getFilesaveIcon()
```
  - getFilenewIcon
```
public static Icon getFilenewIcon()
```
  - getFilecloseIcon
```
public static Icon getFilecloseIcon()
```
  - getPaletteIcon
```
public static Icon getPaletteIcon()
```
  - getBrightIcon
```
public static Icon getBrightIcon()
```
  - getAutocontrastIcon
```
public static Icon getAutocontrastIcon()
```
  - getImageIcon
```
public static Icon getImageIcon()
```
  - getTableIcon
```
public static Icon getTableIcon()
```
  - getTextIcon
```
public static Icon getTextIcon()
```
  - getImageIconA
```
public static Icon getImageIconA()
```
  - getTableIconA
```
public static Icon getTableIconA()
```
  - getTextIconA
```
public static Icon getTextIconA()
```
  - getZoominIcon
```
public static Icon getZoominIcon()
```
  - getZoomoutIcon
```
public static Icon getZoomoutIcon()
```
  - getBlankIcon
```
public static Icon getBlankIcon()
```
  - getHelpIcon
```
public static Icon getHelpIcon()
```
  - getCopyIcon
```
public static Icon getCopyIcon()
```
  - getCutIcon
```
public static Icon getCutIcon()
```
  - getPasteIcon
```
public static Icon getPasteIcon()
```
  - getLargeHdfIcon
```
public static Icon getLargeHdfIcon()
```
  - getPreviousIcon
```
public static Icon getPreviousIcon()
```
  - getNextIcon
```
public static Icon getNextIcon()
```
  - getFirstIcon
```
public static Icon getFirstIcon()
```
  - getLastIcon
```
public static Icon getLastIcon()
```
  - getChartIcon
```
public static Icon getChartIcon()
```
  - getAnimationIcon
```
public static Icon getAnimationIcon()
```
  - getAppsIcon
```
public static ImageIcon getAppsIcon()
```
  - getUrlIcon
```
public static ImageIcon getUrlIcon()
```
  - getVideoIcon
```
public static ImageIcon getVideoIcon()
```
  - getXlsIcon
```
public static ImageIcon getXlsIcon()
```
  - getPdfIcon
```
public static ImageIcon getPdfIcon()
```
  - getAudioIcon
```
public static ImageIcon getAudioIcon()
```
  - getQuestionIcon
```
public static Icon getQuestionIcon()
```
  - loadIcons
```
public static void loadIcons()
```
  - load
```
public void load()
          throws Exception
```
    Load user properties from property file
    
    Throws:
    
    Exception - if a failure occurred
  - save
```
public void save()
```
    Save user properties into property file
  - getPropertyFile
```
public static String getPropertyFile()
```
    Returns:
    
    the name of the user property file
  - getWorkDir
```
public static String getWorkDir()
```
    Returns:
    
    the default work directory, where the open file starts.
  - getMaxRecentFiles
```
public static int getMaxRecentFiles()
```
    Returns:
    
    the maximum number of the most recent file
  - getUsersGuide
```
public static String getUsersGuide()
```
    Returns:
    
    the path of the HDFView users guide
  - getDataDelimiter
```
public static String getDataDelimiter()
```
    Returns:
    
    the delimiter of data values
  - getImageOrigin
```
public static String getImageOrigin()
```
    Returns:
    
    the image origin
  - getIndexType
```
public static String getIndexType()
```
    Returns:
    
    the default index type for display
  - getIndexOrder
```
public static String getIndexOrder()
```
    Returns:
    
    the default index order for display
  - getFontSize
```
public static int getFontSize()
```
    Returns:
    
    the font size
  - getFontType
```
public static String getFontType()
```
    Returns:
    
    the font type
  - getFileExtension
```
public static String getFileExtension()
```
    Returns:
    
    the file extensions of supported file formats
  - setFontSize
```
public static void setFontSize(int fsize)
```
    sets the font size
    
    Parameters:
    
    fsize - the font size
  - setFontType
```
public static void setFontType(String ftype)
```
    sets the font type
    
    Parameters:
    
    ftype - the font type
  - getH4toH5
```
public static String getH4toH5()
```
    Returns:
    
    the path of the H5toH5 converter
  - getMRF
```
public static Vector<String> getMRF()
```
    Returns:
    
    the list of most recent files
  - getPaletteList
```
public static Vector<String> getPaletteList()
```
    Returns:
    
    the list of palette files
  - getSrbAccount
```
public static Vector<String[]> getSrbAccount()
```
  - getTreeViewList
```
public static Vector<String> getTreeViewList()
```
    Returns:
    
    a list of treeview modules
  - getMetaDataViewList
```
public static Vector<String> getMetaDataViewList()
```
    Returns:
    
    a list of metadataview modules
  - getTextViewList
```
public static Vector<String> getTextViewList()
```
    Returns:
    
    a list of textview modules
  - getTableViewList
```
public static Vector<String> getTableViewList()
```
    Returns:
    
    a list of tableview modules
  - getImageViewList
```
public static Vector<String> getImageViewList()
```
    Returns:
    
    a list of imageview modules
  - getPaletteViewList
```
public static Vector<String> getPaletteViewList()
```
    Returns:
    
    a list of paletteview modules
  - getHelpViewList
```
public static Vector<String> getHelpViewList()
```
    Returns:
    
    a list of helpview modules
  - setUsersGuide
```
public static void setUsersGuide(String str)
```
    set the path of H5View User's guide
    
    Parameters:
    
    str - the path
  - setH4toH5
```
public static void setH4toH5(String tool)
```
    set the path of the H4 to H5 converter
    
    Parameters:
    
    tool - the path of the H4 to H5 converter
  - setWorkDir
```
public static void setWorkDir(String wDir)
```
    set the path of the default work directory
    
    Parameters:
    
    wDir - the default work directory
  - setFileExtension
```
public static void setFileExtension(String ext)
```
    set the file extension
    
    Parameters:
    
    ext - the file extension
  - setDataDelimiter
```
public static void setDataDelimiter(String delim)
```
    set the delimiter of data values
    
    Parameters:
    
    delim - the delimiter of data values
  - setImageOrigin
```
public static void setImageOrigin(String o)
```
    set the image origin
    
    Parameters:
    
    o - the image origin
  - setIndexType
```
public static void setIndexType(String idxType)
```
    set the index type
    
    Parameters:
    
    idxType - the index type
  - setIndexOrder
```
public static void setIndexOrder(String idxOrder)
```
    set the index order
    
    Parameters:
    
    idxOrder - the index order
  - setMaxMembers
```
public static void setMaxMembers(int n)
```
    Current Java applications such as HDFView cannot handle files with large number of objects such as 1,000,000 objects. setMaxMembers() sets the maximum number of objects that will be loaded into memory.
    
    Parameters:
    
    n - the maximum number of objects to load into memory
  - setStartMembers
```
public static void setStartMembers(int idx)
```
    Current Java applications such as HDFView cannot handle files with large number of objects such as 1,000,000 objects. setStartMember() sets the starting index of objects that will be loaded into memory.
    
    Parameters:
    
    idx - the maximum number of objects to load into memory
  - getMaxMembers
```
public static int getMaxMembers()
```
    Current Java applications such as HDFView cannot handle files with large number of objects such as 1,000,000 objects. getMaxMembers() returns the maximum number of objects that will be loaded into memory.
    
    Returns:
    
    the maximum members
  - getStartMembers
```
public static int getStartMembers()
```
    Current Java applications such as HDFView cannot handle files with large number of objects such as 1,000,000 objects. getStartMembers() returns the starting index of objects that will be loaded into memory.
    
    Returns:
    
    the start members
  - isAutoContrast
```
public static boolean isAutoContrast()
```
    Returns true if auto contrast is used in image processing.
    
    Returns:
    
    true if auto contrast is used in image processing; otherwise, returns false.
  - showImageValues
```
public static boolean showImageValues()
```
    Returns true if "show image values" is set.
    
    Returns:
    
    true if "show image values" is set; otherwise, returns false.
  - setAutoContrast
```
public static void setAutoContrast(boolean b)
```
    Set the flag to indicate if auto contrast is used in image process.
    
    Parameters:
    
    b - the flag to indicate if auto contrast is used in image process.
  - setShowImageValue
```
public static void setShowImageValue(boolean b)
```
    Set the flag to indicate if "show image values" is set.
    
    Parameters:
    
    b - the flag to indicate if if "show image values" is set.
  - isReadOnly
```
public static boolean isReadOnly()
```
    Returns true if default file access is read only.
    
    Returns:
    
    true if default file access is read only; otherwise, returns false.
  - setReadOnly
```
public static void setReadOnly(boolean b)
```
    Set the flag to indicate if default file access is read only.
    
    Parameters:
    
    b - the flag to indicate if default file access is read only.
  - isEarlyLib
```
public static boolean isEarlyLib()
```
    Returns true if default lib version is the earliest.
    
    Returns:
    
    true if default lib version is the earliest; otherwise, returns false.
  - setEarlyLib
```
public static void setEarlyLib(boolean b)
```
    Set the flag to indicate if default lib version is the earliest.
    
    Parameters:
    
    b - the flag to indicate if default lib version is the earliest.
  - isConvertEnum
```
public static boolean isConvertEnum()
```
    Returns:
    
    the convertEnum
  - showRegRefValues
```
public static boolean showRegRefValues()
```
    Returns true if "show regref values" is set.
    
    Returns:
    
    true if "show regref values" is set; otherwise, returns false.
  - isIndexBase1
```
public static boolean isIndexBase1()
```
    Returns:
    
    the isIndexBase1
  - setConvertEnum
```
public static void setConvertEnum(boolean convertEnum)
```
    Parameters:
    
    convertEnum - the convertEnum to set
  - setShowRegRefValue
```
public static void setShowRegRefValue(boolean b)
```
    Set the flag to indicate if "show RegRef values" is set.
    
    Parameters:
    
    b - the flag to indicate if if "show RegRef values" is set.
  - setIndexBase1
```
public static void setIndexBase1(boolean b)
```
    Set the flag to indicate if IndexBase should start at 1.
    
    Parameters:
    
    b - the flag to indicate if IndexBase should start at 1.

Class ViewProperties

Nested Class Summary

Field Summary

Fields inherited from class Properties

Constructor Summary

Method Summary

Methods inherited from class Properties

Methods inherited from class Hashtable

Methods inherited from class Object

Field Detail

VERSION

MAX_RECENT_FILES

DELIMITER_TAB

DELIMITER_COMMA

DELIMITER_SPACE

DELIMITER_COLON

ORIGIN_UL

ORIGIN_LL

ORIGIN_UR

ORIGIN_LR

DELIMITER_SEMI_COLON

Constructor Detail

ViewProperties

Method Detail

keys

loadExtClass

getViewRoot

getFoldercloseIcon

getFoldercloseIconA

getFolderopenIcon

getFolderopenIconA

getHdfIcon

getH4Icon

getH4IconR

getH5Icon

getH5IconR

getDatasetIcon

getDatasetIconA

getDatatypeIcon

getDatatypeIconA

getLinkIcon

getFileopenIcon

getFilesaveIcon

getFilenewIcon

getFilecloseIcon

getPaletteIcon

getBrightIcon

getAutocontrastIcon

getImageIcon

getTableIcon

getTextIcon

getImageIconA

getTableIconA

getTextIconA

getZoominIcon

getZoomoutIcon

getBlankIcon

getHelpIcon

getCopyIcon

getCutIcon

getPasteIcon

getLargeHdfIcon

getPreviousIcon

getNextIcon

getFirstIcon

getLastIcon

getChartIcon

getAnimationIcon

getAppsIcon

getUrlIcon

getVideoIcon

getXlsIcon

getPdfIcon

getAudioIcon

getQuestionIcon

loadIcons

load

save

getPropertyFile

getWorkDir