com.sas.swing.visuals.remotefileselector
Interface RemoteFileComponentInterface

All Known Implementing Classes:

RemoteFileComponent, RemoteFileListComponent, RemoteFileTableComponent, RemoteFileTreeComponent

public interface RemoteFileComponentInterface

Interface defining what the main view component of the RemoteFileSelector component must support.

Since:

3.0

Method Summary

abstract void	addPropertyChangeListener(java.beans.PropertyChangeListener listener) Adds a PropertyChangeListener to the support class.
abstract java.lang.Object[]	getColumnRenderers() Returns the array of cell renderers currently being used to format the columns.
abstract java.util.List	getPreviousPath() Returns the a list containing the file system paths previously viewed.
abstract RemoteFileServerModelInterface	getRemoteModel() Returns the model used to display the data.
abstract java.lang.Object	getSelectionObject() Returns the selection object associated with the view.
abstract java.util.List	getSelections() Return the selections made in the view.
abstract javax.swing.JComponent	getViewComponent() Returns the actual component displaying the data.
abstract boolean	isShowDirectoriesOnly() Returns the showDirectoriesOnly attribute.
abstract void	refreshData(java.lang.String path) Triggers a refresh of the view display.
abstract void	removePropertyChangeListener(java.beans.PropertyChangeListener listener) Removes a PropertyChangeListener from the support class.
abstract void	setActionProvider(SwingActionProvider actionProvider) Sets the ActionProviderFramework class.
abstract void	setColumnRenderers(java.lang.Object[] columnRenderers) Sets the array of cell renderers used to format the columns.
abstract void	setPath(java.lang.String path) Sets the path to be viewed.
abstract void	setPreviousPath(java.util.List previousPath) Sets a list of previous paths.
abstract void	setRemoteModel(RemoteFileServerModelInterface model) Sets the model to be used to display the data.
abstract void	setSelectionObject(java.lang.Object selectionObject) Sets the selection object associated with the view.
abstract void	setShowDirectoriesOnly(boolean showDirectoriesOnly) Sets the showDirectoriesOnly attribute.

Method Detail

getSelections

java.util.List getSelections()

Return the selections made in the view.

Returns:

a list of Strings containing the selections

getSelectionObject

java.lang.Object getSelectionObject()

Returns the selection object associated with the view. Used to maintain the selections from one view to another.

Returns:

the component's selection object

setSelectionObject

void setSelectionObject(java.lang.Object selectionObject)

Sets the selection object associated with the view. Used to maintain the selections from one view to another.

refreshData

void refreshData(java.lang.String path)

Triggers a refresh of the view display.

Parameters:

path - the path currently being viewed.

getPreviousPath

java.util.List getPreviousPath()

Returns the a list containing the file system paths previously viewed.

Returns:

a list of Strings with the previous paths

See Also:

setPreviousPath(List)

setPreviousPath

void setPreviousPath(java.util.List previousPath)

Sets a list of previous paths.

Parameters:

previousPath - list of Strings containing paths

See Also:

getPreviousPath()

getViewComponent

javax.swing.JComponent getViewComponent()

Returns the actual component displaying the data.

Returns:

the component

setPath

void setPath(java.lang.String path)

Sets the path to be viewed.

Parameters:

path - the path to be viewed

addPropertyChangeListener

void addPropertyChangeListener(java.beans.PropertyChangeListener listener)

Adds a PropertyChangeListener to the support class.

Parameters:

listener - the PropertyChangeListener

removePropertyChangeListener

void removePropertyChangeListener(java.beans.PropertyChangeListener listener)

Removes a PropertyChangeListener from the support class.

Parameters:

listener - the PropertyChangeListener

setRemoteModel

void setRemoteModel(RemoteFileServerModelInterface model)

Sets the model to be used to display the data.

Parameters:

model - the model

See Also:

getRemoteModel()

getRemoteModel

RemoteFileServerModelInterface getRemoteModel()

Returns the model used to display the data.

Returns:

the model

See Also:

setRemoteModel(RemoteFileServerModelInterface)

setShowDirectoriesOnly

void setShowDirectoriesOnly(boolean showDirectoriesOnly)

Sets the showDirectoriesOnly attribute.

Parameters:

showDirectoriesOnly - set to true if only file structure to be shown

See Also:

isShowDirectoriesOnly()

isShowDirectoriesOnly

boolean isShowDirectoriesOnly()

Returns the showDirectoriesOnly attribute.

Returns:

will be set to true if only the file structure is being shown

See Also:

setShowDirectoriesOnly(boolean)

setActionProvider

void setActionProvider(SwingActionProvider actionProvider)

Sets the ActionProviderFramework class.

Parameters:

actionProvider - the action provider class

setColumnRenderers

void setColumnRenderers(java.lang.Object[] columnRenderers)

Sets the array of cell renderers used to format the columns.

Parameters:

columnRenderers - array of cell renderers

See Also:

getColumnRenderers()

getColumnRenderers

java.lang.Object[] getColumnRenderers()

Returns the array of cell renderers currently being used to format the columns.

Returns:

the array of cell renderers

See Also:

setColumnRenderers(Object[])