it.gdapplicazioni.easy.gui

Class FileSaver

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JFileChooser

it.gdapplicazioni.easy.gui.FileSaver

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible

public class FileSaver

extends javax.swing.JFileChooser

CLASS FOR INSTANTIATION AND MANAGEMENT OF FILE SAVE OBJECT
- Supports saving in .txt file (new or existing)
- Supports saving in .csv file (new or existing)
- Supports screenshot components or whole frame in image files
- Supports image capture from the web and saving to file
- Supports serialization of objects in .dat files

Version:

1.0.0.2

Author:

GD Applicazioni

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JFileChooser

javax.swing.JFileChooser.AccessibleJFileChooser

Nested classes/interfaces inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
static int	APPROVE Interaction outcome dialog box approved

Fields inherited from class javax.swing.JFileChooser

ACCEPT_ALL_FILE_FILTER_USED_CHANGED_PROPERTY, accessibleContext, ACCESSORY_CHANGED_PROPERTY, APPROVE_BUTTON_MNEMONIC_CHANGED_PROPERTY, APPROVE_BUTTON_TEXT_CHANGED_PROPERTY, APPROVE_BUTTON_TOOL_TIP_TEXT_CHANGED_PROPERTY, APPROVE_OPTION, APPROVE_SELECTION, CANCEL_OPTION, CANCEL_SELECTION, CHOOSABLE_FILE_FILTER_CHANGED_PROPERTY, CONTROL_BUTTONS_ARE_SHOWN_CHANGED_PROPERTY, CUSTOM_DIALOG, DIALOG_TITLE_CHANGED_PROPERTY, DIALOG_TYPE_CHANGED_PROPERTY, DIRECTORIES_ONLY, DIRECTORY_CHANGED_PROPERTY, ERROR_OPTION, FILE_FILTER_CHANGED_PROPERTY, FILE_HIDING_CHANGED_PROPERTY, FILE_SELECTION_MODE_CHANGED_PROPERTY, FILE_SYSTEM_VIEW_CHANGED_PROPERTY, FILE_VIEW_CHANGED_PROPERTY, FILES_AND_DIRECTORIES, FILES_ONLY, MULTI_SELECTION_ENABLED_CHANGED_PROPERTY, OPEN_DIALOG, SAVE_DIALOG, SELECTED_FILE_CHANGED_PROPERTY, SELECTED_FILES_CHANGED_PROPERTY

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
FileSaver(javax.swing.JFrame parentFrame) CONSTRUCTOR FOR FULL OBJECT INSTANTIATION

Method Summary

Modifier and Type	Method and Description
int	getRESULT() RESULT GETTER
void	saveComponentImageOnFile(java.awt.Component component, java.lang.String fileEextension) METHOD FOR SAVING SCREENSHOTS OF THE FRAME OR ONE OF ITS COMPONENTS TO FILE
void	saveTextOnCsvFile(java.lang.CharSequence text, boolean append, java.lang.String existingFileAlertMessage, java.lang.String existingFileAlertTitle) METHOD FOR SAVING IN .csv FILE - Separators must be included in the text
void	saveTextOnFile(java.lang.CharSequence text, boolean append, java.lang.String existingFileAlertMessage, java.lang.String existingFileAlertTitle) METHOD FOR SAVING IN .txt FILE - Any separators included in the text
void	saveWebImageOnFile(java.lang.String imageUrl, java.lang.String fileEextension) METHOD TO RETRIEVE IMAGE FROM WEB AND SAVE IT TO IMAGE FILE
void	serializeObject(java.lang.Object o, java.lang.String existingFileAlertMessage, java.lang.String existingFileAlertTitle) METHOD FOR SERIALIZING SINGLE OBJECT ON .dat FILE - The instantiating class must be public and implement the Serializable interface
void	serializeObjects(java.util.List<java.lang.Object> obiects, java.lang.String existingFileAlertMessage, java.lang.String existingFileAlertTitle) METHOD FOR SERIALIZING COLLECTION OF OBJECTS - The instantiating class must be public and implement the Serializable interface

Methods inherited from class javax.swing.JFileChooser

accept, addActionListener, addChoosableFileFilter, approveSelection, cancelSelection, changeToParentDirectory, createDialog, ensureFileIsVisible, fireActionPerformed, getAcceptAllFileFilter, getAccessibleContext, getAccessory, getActionListeners, getApproveButtonMnemonic, getApproveButtonText, getApproveButtonToolTipText, getChoosableFileFilters, getControlButtonsAreShown, getCurrentDirectory, getDescription, getDialogTitle, getDialogType, getDragEnabled, getFileFilter, getFileSelectionMode, getFileSystemView, getFileView, getIcon, getName, getSelectedFile, getSelectedFiles, getTypeDescription, getUI, getUIClassID, isAcceptAllFileFilterUsed, isDirectorySelectionEnabled, isFileHidingEnabled, isFileSelectionEnabled, isMultiSelectionEnabled, isTraversable, paramString, removeActionListener, removeChoosableFileFilter, rescanCurrentDirectory, resetChoosableFileFilters, setAcceptAllFileFilterUsed, setAccessory, setApproveButtonMnemonic, setApproveButtonMnemonic, setApproveButtonText, setApproveButtonToolTipText, setControlButtonsAreShown, setCurrentDirectory, setDialogTitle, setDialogType, setDragEnabled, setFileFilter, setFileHidingEnabled, setFileSelectionMode, setFileSystemView, setFileView, setMultiSelectionEnabled, setSelectedFile, setSelectedFiles, setup, showDialog, showOpenDialog, showSaveDialog, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

APPROVE

public static final int APPROVE

Interaction outcome dialog box approved

See Also:

Constant Field Values

Constructor Detail

FileSaver

public FileSaver(javax.swing.JFrame parentFrame)

CONSTRUCTOR FOR FULL OBJECT INSTANTIATION

Parameters:

parentFrame - Object instantiation frame

Method Detail

saveTextOnFile

public void saveTextOnFile(java.lang.CharSequence text,

                           boolean append,

                           java.lang.String existingFileAlertMessage,

                           java.lang.String existingFileAlertTitle)

METHOD FOR SAVING IN .txt FILE
- Any separators included in the text

Parameters:

text - Text to be saved to file

append - Add or overwrite mode (true = add)

existingFileAlertMessage - Message for existing file warning

existingFileAlertTitle - Title for existing file warning

saveTextOnCsvFile

public void saveTextOnCsvFile(java.lang.CharSequence text,

                              boolean append,

                              java.lang.String existingFileAlertMessage,

                              java.lang.String existingFileAlertTitle)

METHOD FOR SAVING IN .csv FILE
- Separators must be included in the text

Parameters:

text - Text to be saved to file

append - Add or overwrite mode (true = add)

existingFileAlertMessage - Message for existing file warning

existingFileAlertTitle - Title for existing file warning

saveComponentImageOnFile

public void saveComponentImageOnFile(java.awt.Component component,

                                     java.lang.String fileEextension)

METHOD FOR SAVING SCREENSHOTS OF THE FRAME OR ONE OF ITS COMPONENTS TO FILE

Parameters:

component - Screenshot component

fileEextension - Generated file format

saveWebImageOnFile

public void saveWebImageOnFile(java.lang.String imageUrl,

                               java.lang.String fileEextension)

METHOD TO RETRIEVE IMAGE FROM WEB AND SAVE IT TO IMAGE FILE

Parameters:

imageUrl - Url of the image to retrieve

fileEextension - Generated file format

serializeObject

public void serializeObject(java.lang.Object o,

                            java.lang.String existingFileAlertMessage,

                            java.lang.String existingFileAlertTitle)

METHOD FOR SERIALIZING SINGLE OBJECT ON .dat FILE
- The instantiating class must be public and implement the Serializable interface

Parameters:

o - Object to be serialized

existingFileAlertMessage - Message for existing file warning

existingFileAlertTitle - Title for existing file warning

serializeObjects

public void serializeObjects(java.util.List<java.lang.Object> obiects,

                             java.lang.String existingFileAlertMessage,

                             java.lang.String existingFileAlertTitle)

METHOD FOR SERIALIZING COLLECTION OF OBJECTS
- The instantiating class must be public and implement the Serializable interface

Parameters:

obiects - Collection of objects to serialize

existingFileAlertMessage - Message for existing file warning

existingFileAlertTitle - Title for existing file warning

getRESULT

public int getRESULT()

RESULT GETTER

Returns:

int