/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to you under the Apache License,
* Version 2.0 (the "License"); you may not use this file except in
* compliance with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.pivot.wtk.skin.terra;
import java.awt.Color;
import java.awt.Font;
import java.io.File;
import java.io.FileFilter;
import java.io.IOException;
import java.text.DateFormat;
import java.util.Comparator;
import java.util.Date;
import org.apache.pivot.collections.ArrayList;
import org.apache.pivot.collections.FilteredList;
import org.apache.pivot.collections.FilteredListListener;
import org.apache.pivot.collections.List;
import org.apache.pivot.collections.ListListener;
import org.apache.pivot.collections.Sequence;
import org.apache.pivot.serialization.SerializationException;
import org.apache.pivot.text.FileSizeFormat;
import org.apache.pivot.util.Filter;
import org.apache.pivot.util.Resources;
import org.apache.pivot.util.concurrent.TaskExecutionException;
import org.apache.pivot.wtk.BoxPane;
import org.apache.pivot.wtk.Button;
import org.apache.pivot.wtk.ButtonPressListener;
import org.apache.pivot.wtk.Component;
import org.apache.pivot.wtk.ComponentKeyListener;
import org.apache.pivot.wtk.ComponentMouseButtonListener;
import org.apache.pivot.wtk.Container;
import org.apache.pivot.wtk.Dimensions;
import org.apache.pivot.wtk.Direction;
import org.apache.pivot.wtk.FileBrowser;
import org.apache.pivot.wtk.HorizontalAlignment;
import org.apache.pivot.wtk.ImageView;
import org.apache.pivot.wtk.Insets;
import org.apache.pivot.wtk.Keyboard;
import org.apache.pivot.wtk.Label;
import org.apache.pivot.wtk.ListButton;
import org.apache.pivot.wtk.ListButtonSelectionListener;
import org.apache.pivot.wtk.ListView;
import org.apache.pivot.wtk.Mouse;
import org.apache.pivot.wtk.Point;
import org.apache.pivot.wtk.PushButton;
import org.apache.pivot.wtk.ScrollPane;
import org.apache.pivot.wtk.SortDirection;
import org.apache.pivot.wtk.Span;
import org.apache.pivot.wtk.TableView;
import org.apache.pivot.wtk.TableViewHeader;
import org.apache.pivot.wtk.TableViewHeaderPressListener;
import org.apache.pivot.wtk.TableViewSelectionListener;
import org.apache.pivot.wtk.TextInput;
import org.apache.pivot.wtk.TextInputTextListener;
import org.apache.pivot.wtk.VerticalAlignment;
import org.apache.pivot.wtk.media.Image;
import org.apache.pivot.wtk.skin.FileBrowserSkin;
import org.apache.pivot.wtkx.WTKX;
import org.apache.pivot.wtkx.WTKXSerializer;
/**
* Terra file browser skin.
*/
public class TerraFileBrowserSkin extends FileBrowserSkin {
/**
* Abstract renderer for displaying file system contents.
*/
public static abstract class FileRenderer extends BoxPane {
protected ImageView imageView = new ImageView();
protected Label label = new Label();
public static final int ICON_WIDTH = 16;
public static final int ICON_HEIGHT = 16;
public static final Image FOLDER_IMAGE;
public static final Image HOME_FOLDER_IMAGE;
public static final Image FILE_IMAGE;
public static final File HOME_DIRECTORY;
static {
try {
FOLDER_IMAGE = Image.load(FileRenderer.class.getResource("folder.png"));
HOME_FOLDER_IMAGE = Image.load(FileRenderer.class.getResource("folder_home.png"));
FILE_IMAGE = Image.load(FileRenderer.class.getResource("page_white.png"));
HOME_DIRECTORY = new File(System.getProperty("user.home"));
} catch (TaskExecutionException exception) {
throw new RuntimeException(exception);
}
}
public FileRenderer() {
getStyles().put("verticalAlignment", VerticalAlignment.CENTER);
add(imageView);
add(label);
imageView.setPreferredSize(ICON_WIDTH, ICON_HEIGHT);
imageView.getStyles().put("backgroundColor", null);
}
@Override
public void setSize(int width, int height) {
super.setSize(width, height);
// Since this component doesn't have a parent, it won't be validated
// via layout; ensure that it is valid here
validate();
}
/**
* Obtains the icon to display for a given file.
*
* @param file
*/
public static Image getIcon(File file) {
Image icon;
if (file.isDirectory()) {
icon = file.equals(HOME_DIRECTORY) ? HOME_FOLDER_IMAGE : FOLDER_IMAGE;
} else {
icon = FILE_IMAGE;
}
return icon;
}
}
/**
* List button file renderer.
*/
public static class ListButtonFileRenderer extends FileRenderer implements Button.DataRenderer {
public ListButtonFileRenderer() {
getStyles().put("horizontalAlignment", HorizontalAlignment.LEFT);
}
@Override
public void render(Object data, Button button, boolean highlight) {
if (data != null) {
File file = (File)data;
// Update the image view
imageView.setImage(getIcon(file));
imageView.getStyles().put("opacity", button.isEnabled() ? 1.0f : 0.5f);
// Update the label
String text = file.getName();
if (text.length() == 0) {
text = System.getProperty("file.separator");
}
label.setText(text);
}
}
}
/**
* List view file renderer.
*/
public static class ListViewFileRenderer extends FileRenderer implements ListView.ItemRenderer {
public ListViewFileRenderer() {
getStyles().put("horizontalAlignment", HorizontalAlignment.LEFT);
getStyles().put("padding", new Insets(2, 3, 2, 3));
}
@Override
public void render(Object item, ListView listView, boolean selected,
boolean checked, boolean highlighted, boolean disabled) {
label.getStyles().put("font", listView.getStyles().get("font"));
Object color = null;
if (listView.isEnabled() && !disabled) {
if (selected) {
if (listView.isFocused()) {
color = listView.getStyles().get("selectionColor");
} else {
color = listView.getStyles().get("inactiveSelectionColor");
}
} else {
color = listView.getStyles().get("color");
}
} else {
color = listView.getStyles().get("disabledColor");
}
label.getStyles().put("color", color);
if (item != null) {
File file = (File)item;
// Update the image view
imageView.setImage(getIcon(file));
imageView.getStyles().put("opacity",
(listView.isEnabled() && !disabled) ? 1.0f : 0.5f);
// Update the label
String text = file.getName();
if (text.length() == 0) {
text = System.getProperty("file.separator");
}
label.setText(text);
}
}
}
/**
* Table view file renderer.
*/
public static class TableViewFileRenderer extends FileRenderer implements TableView.CellRenderer {
public static final String NAME_KEY = "name";
public static final String SIZE_KEY = "size";
public static final String LAST_MODIFIED_KEY = "lastModified";
public TableViewFileRenderer() {
getStyles().put("horizontalAlignment", HorizontalAlignment.CENTER);
getStyles().put("padding", new Insets(2));
}
@Override
public void render(Object value, TableView tableView, TableView.Column column,
boolean rowSelected, boolean rowHighlighted, boolean rowDisabled) {
String columnName = column.getName();
if (value != null) {
File file = (File)value;
String text = null;
Image icon = null;
if (columnName.equals(NAME_KEY)) {
text = file.getName();
icon = getIcon(file);
getStyles().put("horizontalAlignment", HorizontalAlignment.LEFT);
} else if (columnName.equals(SIZE_KEY)) {
long length = file.length();
text = FileSizeFormat.getInstance().format(length);
getStyles().put("horizontalAlignment", HorizontalAlignment.RIGHT);
} else if (columnName.equals(LAST_MODIFIED_KEY)) {
long lastModified = file.lastModified();
Date lastModifiedDate = new Date(lastModified);
DateFormat dateFormat = DateFormat.getDateTimeInstance(DateFormat.SHORT, DateFormat.SHORT);
text = dateFormat.format(lastModifiedDate);
getStyles().put("horizontalAlignment", HorizontalAlignment.RIGHT);
} else {
System.err.println("Unexpected column name in " + getClass().getName()
+ ": " + columnName);
}
label.setText(text);
imageView.setImage(icon);
}
Font font = (Font)tableView.getStyles().get("font");
label.getStyles().put("font", font);
Color color;
if (tableView.isEnabled() && !rowDisabled) {
if (rowSelected) {
if (tableView.isFocused()) {
color = (Color)tableView.getStyles().get("selectionColor");
} else {
color = (Color)tableView.getStyles().get("inactiveSelectionColor");
}
} else {
color = (Color)tableView.getStyles().get("color");
}
} else {
color = (Color)tableView.getStyles().get("disabledColor");
}
label.getStyles().put("color", color);
}
}
/**
* File comparator.
*/
public static class FileComparator implements Comparator<File> {
private String columnName = null;
private SortDirection sortDirection = null;
public FileComparator(String columnName, SortDirection sortDirection) {
this.columnName = columnName;
this.sortDirection = sortDirection;
}
@Override
public int compare(File file1, File file2) {
int result;
if (columnName.equals("name")) {
result = file1.getName().compareToIgnoreCase(file2.getName());
} else if (columnName.equals("size")) {
result = Long.signum(file1.length() - file2.length());
} else if (columnName.equals("lastModified")) {
result = Long.signum(file1.lastModified() - file2.lastModified());
} else {
throw new IllegalArgumentException();
}
result *= (sortDirection == SortDirection.ASCENDING) ? 1 : -1;
return result;
}
}
/**
* File sort handler.
*/
public static class SortHandler implements TableViewHeaderPressListener {
@Override
@SuppressWarnings("unchecked")
public void headerPressed(TableViewHeader tableViewHeader, int index) {
TableView tableView = tableViewHeader.getTableView();
TableView.ColumnSequence columns = tableView.getColumns();
TableView.Column column = columns.get(index);
SortDirection sortDirection = column.getSortDirection();
if (sortDirection == null
|| sortDirection == SortDirection.DESCENDING) {
sortDirection = SortDirection.ASCENDING;
} else {
sortDirection = SortDirection.DESCENDING;
}
List<File> files = (List<File>)tableView.getTableData();
files.setComparator(new FileComparator(column.getName(), sortDirection));
for (int i = 0, n = columns.getLength(); i < n; i++) {
column = columns.get(i);
column.setSortDirection(i == index ? sortDirection : null);
}
}
}
/**
* File name filter.
*/
public static class FileNameFilter implements Filter<File> {
private String match;
public FileNameFilter(String match) {
this.match = match.toLowerCase();
}
@Override
public boolean include(File file) {
String name = file.getName();
name = name.toLowerCase();
boolean include;
if (match.startsWith("*")) {
if (match.length() == 1) {
include = true;
} else {
include = name.contains(match.substring(1));
}
} else {
include = name.startsWith(match);
}
return include;
}
}
private Component content = null;
@WTKX private ListButton pathListButton = null;
@WTKX private PushButton goUpButton = null;
@WTKX private PushButton newFolderButton = null;
@WTKX private PushButton goHomeButton = null;
@WTKX private TextInput searchTextInput = null;
@WTKX private ScrollPane fileScrollPane = null;
@WTKX private TableView fileTableView = null;
private FilteredList<File> files = new FilteredList<File>();
private boolean keyboardFolderTraversalEnabled = true;
private boolean updatingSelection = false;
private static final FileFilter HIDDEN_FILE_FILTER = new FileFilter() {
@Override
public boolean accept(File file) {
return !file.isHidden();
}
};
@Override
public void install(Component component) {
super.install(component);
final FileBrowser fileBrowser = (FileBrowser)component;
Resources resources;
try {
resources = new Resources(getClass().getName());
} catch (IOException exception) {
throw new RuntimeException(exception);
} catch (SerializationException exception) {
throw new RuntimeException(exception);
}
WTKXSerializer wtkxSerializer = new WTKXSerializer(resources);
try {
content = (Component)wtkxSerializer.readObject(this, "terra_file_browser_skin.wtkx");
} catch (IOException exception) {
throw new RuntimeException(exception);
} catch (SerializationException exception) {
throw new RuntimeException(exception);
}
fileBrowser.add(content);
wtkxSerializer.bind(this, TerraFileBrowserSkin.class);
pathListButton.getListButtonSelectionListeners().add(new ListButtonSelectionListener() {
@Override
public void selectedIndexChanged(ListButton listButton, int previousSelectedIndex) {
File ancestorDirectory = (File)listButton.getSelectedItem();
if (ancestorDirectory != null) {
fileBrowser.setRootDirectory(ancestorDirectory);
}
}
});
goUpButton.getButtonPressListeners().add(new ButtonPressListener() {
@Override
public void buttonPressed(Button button) {
File rootDirectory = fileBrowser.getRootDirectory();
File parentDirectory = rootDirectory.getParentFile();
fileBrowser.setRootDirectory(parentDirectory);
}
});
newFolderButton.getButtonPressListeners().add(new ButtonPressListener() {
@Override
public void buttonPressed(Button button) {
// TODO
}
});
goHomeButton.getButtonPressListeners().add(new ButtonPressListener() {
@Override
public void buttonPressed(Button button) {
fileBrowser.setRootDirectory(new File(System.getProperty("user.home")));
}
});
searchTextInput.getComponentKeyListeners().add(new ComponentKeyListener.Adapter() {
@Override
public boolean keyPressed(Component component, int keyCode, Keyboard.KeyLocation keyLocation) {
boolean consumed = super.keyPressed(component, keyCode, keyLocation);
if (keyCode == Keyboard.KeyCode.ESCAPE) {
searchTextInput.setText("");
consumed = true;
} else if (keyCode == Keyboard.KeyCode.DOWN) {
if (files.getLength() > 0) {
fileTableView.setSelectedIndex(0);
fileTableView.requestFocus();
}
}
return consumed;
}
});
searchTextInput.getTextInputTextListeners().add(new TextInputTextListener() {
@Override
public void textChanged(TextInput textInput) {
String text = textInput.getText();
if (text.length() == 0) {
files.setFilter(null);
} else {
files.setFilter(new FileNameFilter(text));
}
}
});
fileTableView.getTableViewSelectionListeners().add(new TableViewSelectionListener() {
@Override
public void selectedRangeAdded(TableView tableView, int rangeStart, int rangeEnd) {
updatingSelection = true;
for (int i = rangeStart; i <= rangeEnd; i++) {
File file = files.get(i);
fileBrowser.addSelectedFile(file);
}
updatingSelection = false;
}
@Override
public void selectedRangeRemoved(TableView tableView, int rangeStart, int rangeEnd) {
updatingSelection = true;
for (int i = rangeStart; i <= rangeEnd; i++) {
File file = files.get(i);
fileBrowser.removeSelectedFile(file);
}
updatingSelection = false;
}
@Override
@SuppressWarnings("unchecked")
public void selectedRangesChanged(TableView tableView, Sequence<Span> previousSelectedRanges) {
updatingSelection = true;
Sequence<File> files = (Sequence<File>)tableView.getSelectedRows();
for (int i = 0, n = files.getLength(); i < n; i++) {
File file = files.get(i);
files.update(i, file);
}
fileBrowser.setSelectedFiles(files);
updatingSelection = false;
}
});
fileTableView.getComponentMouseButtonListeners().add(new ComponentMouseButtonListener.Adapter() {
private int index = -1;
@Override
public boolean mouseClick(Component component, Mouse.Button button, int x, int y, int count) {
boolean consumed = super.mouseClick(component, button, x, y, count);
if (count == 1) {
index = fileTableView.getRowAt(y);
} else if (count == 2) {
int index = fileTableView.getRowAt(y);
if (index != -1
&& index == this.index
&& fileTableView.isRowSelected(index)) {
File file = files.get(index);
if (file.isDirectory()) {
fileBrowser.setRootDirectory(file);
consumed = true;
}
}
}
return consumed;
}
});
files.getListListeners().add(new ListListener.Adapter<File>() {
@Override
public void comparatorChanged(List<File> list, Comparator<File> previousComparator) {
fileBrowser.clearSelection();
}
});
files.getFilteredListListeners().add(new FilteredListListener.Adapter<File>() {
@Override
public void filterChanged(FilteredList<File> filteredList, Filter<File> previousFilter) {
fileBrowser.clearSelection();
}
});
fileTableView.setTableData(files);
fileBrowser.setFocusTraversalPolicy(new IndexFocusTraversalPolicy() {
@Override
public Component getNextComponent(Container container, Component component, Direction direction) {
Component nextComponent;
if (component == null) {
nextComponent = fileTableView;
} else {
nextComponent = super.getNextComponent(container, component, direction);
}
return nextComponent;
}
});
rootDirectoryChanged(fileBrowser, null);
selectedFilesChanged(fileBrowser, null);
}
@Override
public void uninstall() {
FileBrowser fileBrowser = (FileBrowser)getComponent();
fileBrowser.remove(content);
content = null;
super.uninstall();
}
@Override
public int getPreferredWidth(int height) {
return content.getPreferredWidth(height);
}
@Override
public int getPreferredHeight(int width) {
return content.getPreferredHeight(width);
}
@Override
public Dimensions getPreferredSize() {
return content.getPreferredSize();
}
@Override
public void layout() {
int width = getWidth();
int height = getHeight();
content.setLocation(0, 0);
content.setSize(width, height);
}
@Override
public File getFileAt(int x, int y) {
File file = null;
FileBrowser fileBrowser = (FileBrowser)getComponent();
Component component = fileBrowser.getDescendantAt(x, y);
if (component == fileTableView) {
Point location = fileTableView.mapPointFromAncestor(fileBrowser, x, y);
int index = fileTableView.getRowAt(location.y);
if (index != -1) {
file = files.get(index);
}
}
return file;
}
public boolean isKeyboardFolderTraversalEnabled() {
return keyboardFolderTraversalEnabled;
}
public void setKeyboardFolderTraversalEnabled(boolean keyboardFolderTraversalEnabled) {
this.keyboardFolderTraversalEnabled = keyboardFolderTraversalEnabled;
}
@Override
public boolean keyPressed(Component component, int keyCode, Keyboard.KeyLocation keyLocation) {
boolean consumed = super.keyPressed(component, keyCode, keyLocation);
FileBrowser fileBrowser = (FileBrowser)getComponent();
if (keyCode == Keyboard.KeyCode.ENTER
&& keyboardFolderTraversalEnabled) {
Sequence<File> selectedFiles = fileBrowser.getSelectedFiles();
if (selectedFiles.getLength() == 1) {
File selectedFile = selectedFiles.get(0);
if (selectedFile.isDirectory()) {
fileBrowser.setRootDirectory(selectedFile);
consumed = true;
}
}
} else if (keyCode == Keyboard.KeyCode.DELETE
|| keyCode == Keyboard.KeyCode.BACKSPACE) {
File rootDirectory = fileBrowser.getRootDirectory();
File parentDirectory = rootDirectory.getParentFile();
if (parentDirectory != null) {
fileBrowser.setRootDirectory(parentDirectory);
consumed = true;
}
} else if (keyCode == Keyboard.KeyCode.F5) {
refreshFileList();
consumed = true;
}
return consumed;
}
@Override
public boolean keyReleased(Component component, int keyCode, Keyboard.KeyLocation keyLocation) {
boolean consumed = super.keyReleased(component, keyCode, keyLocation);
if (keyCode == Keyboard.KeyCode.F
&& Keyboard.isPressed(Keyboard.Modifier.CTRL)) {
searchTextInput.requestFocus();
consumed = true;
}
return consumed;
}
@Override
public void rootDirectoryChanged(FileBrowser fileBrowser, File previousRootDirectory) {
ArrayList<File> path = new ArrayList<File>();
File rootDirectory = fileBrowser.getRootDirectory();
File ancestorDirectory = rootDirectory.getParentFile();
while (ancestorDirectory != null) {
path.add(ancestorDirectory);
ancestorDirectory = ancestorDirectory.getParentFile();
}
pathListButton.setListData(path);
pathListButton.setButtonData(rootDirectory);
goUpButton.setEnabled(rootDirectory.getParentFile() != null);
File homeDirectory = new File(System.getProperty("user.home"));
goHomeButton.setEnabled(!rootDirectory.equals(homeDirectory));
searchTextInput.setText("");
fileScrollPane.setScrollTop(0);
fileScrollPane.setScrollLeft(0);
refreshFileList();
fileTableView.requestFocus();
}
@Override
public void selectedFileAdded(FileBrowser fileBrowser, File file) {
if (!updatingSelection) {
int index = files.indexOf(file);
if (index != -1) {
fileTableView.addSelectedIndex(index);
}
}
}
@Override
public void selectedFileRemoved(FileBrowser fileBrowser, File file) {
if (!updatingSelection) {
int index = files.indexOf(file);
if (index != -1) {
fileTableView.removeSelectedIndex(index);
}
}
}
@Override
public void selectedFilesChanged(FileBrowser fileBrowser, Sequence<File> previousSelectedFiles) {
if (!updatingSelection) {
fileTableView.clearSelection();
Sequence<File> selectedFiles = fileBrowser.getSelectedFiles();
for (int i = 0, n = selectedFiles.getLength(); i < n; i++) {
File selectedFile = selectedFiles.get(i);
int index = files.indexOf(selectedFile);
if (index != -1) {
fileTableView.addSelectedIndex(index);
}
}
}
}
@Override
public void multiSelectChanged(FileBrowser fileBrowser) {
fileTableView.setSelectMode(fileBrowser.isMultiSelect() ?
TableView.SelectMode.MULTI : TableView.SelectMode.SINGLE);
}
@Override
public void disabledFileFilterChanged(FileBrowser fileBrowser, Filter<File> previousDisabledFileFilter) {
fileTableView.setDisabledRowFilter(fileBrowser.getDisabledFileFilter());
}
private void refreshFileList() {
FileBrowser fileBrowser = (FileBrowser)getComponent();
File rootDirectory = fileBrowser.getRootDirectory();
files.setSource(new ArrayList<File>(rootDirectory.listFiles(HIDDEN_FILE_FILTER)));
}
}