FileListContent (NetPhantom® 7.7 Java API Specification)

java.lang.Object
- se.entra.phantom.server.FileListContent

```
public class FileListContent
extends Object
```
Handles the contents of a list for comboboxes and spin buttons that might be either static (containing references to host fields or text prompts) or dynamic file content (also containing references).

Constructor Summary

Constructors
Constructor and Description
`FileListContent(PhantomFile data, boolean isHostConverted)` Creates the contents from a static list in a vector that is read from the PHW file after the control (combobox and spin button) data.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static FileListContent`	`createEmpty()` Gets an empty contents file when e.g.
`static Vector<String>`	`formatTextPrompt(Vector<String> v, VirtualPanel panel)` Formats a vector of the original list text prompt content with the NetPhantom text prompt standard.
`static Vector<String>`	`formatTextPrompt(Vector<String> v, VirtualPanel panel, Object[] isChanged)` Formats a vector of the original list text prompt content with the NetPhantom text prompt standard.
`static FileListContent`	`getFileListContent(PhantomRuntime runtime, String fileName)` Gets a file list content and saves it globally in a hash table.
`String`	`getFileName()` Gets the file name (or null if static inside the PHW file).
`long`	`getLastModified()` Gets the last modified time of the file.
`Vector<String>[]`	`getVectors()` Gets the two vectors for contents and host conversion.
`boolean`	`isLoaded()` Checks if the file is loaded OK.
`void`	`sortList()` Sorts the lists.
`static Vector<String>`	`sortList(Enumeration<String> e)` Sorts an enumeration of strings in alphabetical order.
`static void`	`sortList(Enumeration<String> e, VirtualControl list)` Sorts an enumeration of strings in alphabetical order.
`static Vector<String>`	`sortList(StringTokenizer e)` Sorts an enumeration of strings in alphabetical order.
`static void`	`sortList(StringTokenizer e, VirtualControl list)` Sorts an enumeration of strings in alphabetical order.
`static Vector<String>`	`sortList(Vector<String> vector)` Sorts the list in alphabetical order.
`static void`	`sortList(Vector<String>[] twoVectors)` Sorts the list.
`static void`	`sortList(Vector<String> vector, VirtualControl list)` Sorts the list in alphabetical order.
`static String`	`stripEndingSpaces(String s)` Strips ending spaces from a string.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - FileListContent
```
public FileListContent(PhantomFile data,
                       boolean isHostConverted)
                throws IOException
```
    Creates the contents from a static list in a vector that is read from the PHW file after the control (combobox and spin button) data.
    
    Throws:
    
    IOException - if an I/O error occurs.
- Method Detail
  - createEmpty
```
public static FileListContent createEmpty()
```
    Gets an empty contents file when e.g. file name is not specified.
    
    Returns:
    
    A new empty instance of the file contents.
  - getFileName
```
public String getFileName()
```
    Gets the file name (or null if static inside the PHW file). If inside the JAR file, it is a specification such as "jar:.../!filename".
  - getLastModified
```
public long getLastModified()
```
    Gets the last modified time of the file. If this variable changes, the getListContents method will reload the file. This processing is done synchronously, so the integrity of the data vector is kept. If the file comes from a JAR file or the class loader, the time stamp is set to the timestamp of the JAR file.
  - isLoaded
```
public boolean isLoaded()
```
    Checks if the file is loaded OK.
  - getFileListContent
```
public static FileListContent getFileListContent(PhantomRuntime runtime,
                                                 String fileName)
```
    Gets a file list content and saves it globally in a hash table. The file name is relative the runtime or application.
    If the file has been modified since last call, the existing instance of FileListContent is reloaded.
    If a file error occurs, an event is logged, the list will contain the string "Cannot load file: nnn" and no error is returned.
  - getVectors
```
public Vector<String>[] getVectors()
```
    Gets the two vectors for contents and host conversion. The host conversion vector may be null if no conversion exists.
  - sortList
```
public void sortList()
```
    Sorts the lists. This cannot be called if the content is from a file.
  - sortList
```
public static Vector<String> sortList(Vector<String> vector)
```
    Sorts the list in alphabetical order. The vector should contain strings.
    
    Returns:
    
    a new vector with the reordered contents.
  - sortList
```
public static Vector<String> sortList(StringTokenizer e)
```
    Sorts an enumeration of strings in alphabetical order.
    
    Returns:
    
    a new vector with the reordered contents.
  - sortList
```
public static Vector<String> sortList(Enumeration<String> e)
```
    Sorts an enumeration of strings in alphabetical order.
    
    Returns:
    
    a new vector with the reordered contents.
  - sortList
```
public static void sortList(Vector<String> vector,
                            VirtualControl list)
```
    Sorts the list in alphabetical order. The vector should contain strings. The reordered strings are then inserted into the list (the list is not cleared before insertion).
  - sortList
```
public static void sortList(StringTokenizer e,
                            VirtualControl list)
```
    Sorts an enumeration of strings in alphabetical order. The reordered strings are then inserted into the list (the list is not cleared before insertion).
  - sortList
```
public static void sortList(Enumeration<String> e,
                            VirtualControl list)
```
    Sorts an enumeration of strings in alphabetical order. The reordered strings are then inserted into the list (the list is not cleared before insertion).
  - sortList
```
public static void sortList(Vector<String>[] twoVectors)
```
    Sorts the list. The array must be of length = 2 and is modified by the function. The first vector contains the string elements and the second is null or contains the host converted strings (that are sorted according to the first array in order to keep the items matching).
  - formatTextPrompt
```
public static Vector<String> formatTextPrompt(Vector<String> v,
                                              VirtualPanel panel)
```
    Formats a vector of the original list text prompt content with the NetPhantom text prompt standard. If no changes are done, the original vector is returned, otherwise a cloned one with a new content.
  - formatTextPrompt
```
public static Vector<String> formatTextPrompt(Vector<String> v,
                                              VirtualPanel panel,
                                              Object[] isChanged)
```
    Formats a vector of the original list text prompt content with the NetPhantom text prompt standard. If no changes are done, the original vector is returned, otherwise a cloned one with a new content.
    The parameter "isChanged" should be null or an Object[1] array initiated with null as Object[0]. Upon return, the Object[0] member is non-null if the text is formatted according to the panel causing the file not to be able to be cached on the client.
  - stripEndingSpaces
```
public static String stripEndingSpaces(String s)
```
    Strips ending spaces from a string.

Class FileListContent

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FileListContent

Method Detail

createEmpty

getFileName

getLastModified

isLoaded

getFileListContent

getVectors

sortList

sortList

sortList

sortList

sortList

sortList

sortList

sortList

formatTextPrompt

formatTextPrompt

stripEndingSpaces