org.mdi.bootstrap

Class FileProperties<C>

java.lang.Object

org.mdi.bootstrap.FileProperties<C>

Type Parameters:

C - the component class

Direct Known Subclasses:

SwingFileProperties

public class FileProperties<C>
extends java.lang.Object

Represent the properties of a tab in an Application.

Field Summary

Fields

Modifier and Type	Field and Description
protected C	comp The associated component which is encapsulated in the associated tab.
protected java.lang.String	name The tab name.
protected java.lang.Object	obj The associated Object.
protected MetaData	properties The associated properties.
protected java.net.URL	url The associated URL (may be null).

Constructor Summary

Constructors

Constructor and Description
FileProperties(java.lang.String name, C comp) Create a new FileProperties without any defined properties.
FileProperties(java.lang.String name, C comp, boolean isCloseable) Create a new FileProperties without any defined properties.
FileProperties(java.lang.String name, C comp, boolean isCloseable, boolean isEditable) Create a new FileProperties without any defined properties.
FileProperties(java.lang.String name, C comp, java.lang.Object obj) Create a new FileProperties without any defined properties, and associate it with an Object.
FileProperties(java.lang.String name, C comp, java.lang.Object obj, boolean isCloseable) Create a new FileProperties without any defined properties, and associate it with an Object.
FileProperties(java.lang.String name, C comp, java.lang.Object obj, boolean isCloseable, boolean isEditable) Create a new FileProperties without any defined properties, and associate it with an Object.
FileProperties(java.lang.String name, C comp, java.lang.Object obj, MetaData properties) Create a new FileProperties with some defined properties, and associate it with an Object.
FileProperties(java.lang.String name, C comp, java.lang.Object obj, MetaData properties, boolean isCloseable, boolean isEditable) Create a new FileProperties with some defined properties, and associate it with an Object.

Method Summary

Modifier and Type	Method and Description
C	getComponent() Return the FileProperties associated panel.
java.io.File	getFile() Return the associated File (may be null).
MetaData	getMetaData() Return the MetaData associated with the panel.
java.lang.String	getName() Return the name of the panel.
java.lang.Object	getObject() Return the associated Object, if it exists, or else return null.
java.net.URL	getURL() Return the associated URL (may be null).
boolean	isCloseable() Return true if the associated tab is closeable.
boolean	isCompatibleWith(FileProperties prop) Same as isCompatibleWith(org.mdi.bootstrap.FileProperties, boolean), with only partial compatibility.
boolean	isCompatibleWith(FileProperties prop, boolean complete) Look if two FileProperties are compatible.
boolean	isCompatibleWith(MetaData meta) Same as isCompatibleWith(MetaData, boolean), with only partial compatibility.
boolean	isCompatibleWith(MetaData meta, boolean complete) Look if two FileProperties are compatible.
boolean	isEditable() Return true if the associated tab message area is isEditable.
void	setCloseable(boolean isCloseable) Set if the associated tab is closeable.
void	setEditable(boolean isEditable) Set if the associated tab message area is isEditable.
void	setMetaData(MetaData properties) Set the MetaData to associate with the panel.
void	setName(java.lang.String name) Set the name of the panel.
void	setObject(java.lang.Object obj) Set the associated Object.
void	setURL(java.net.URL url) Set the associated URL.

Methods inherited from class java.lang.Object

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

Field Detail

properties

protected MetaData properties

The associated properties.

name

protected java.lang.String name

The tab name.

comp

protected C comp

The associated component which is encapsulated in the associated tab.

obj

protected java.lang.Object obj

The associated Object.

url

protected java.net.URL url

The associated URL (may be null).

Constructor Detail

FileProperties

public FileProperties(java.lang.String name,
                      C comp)

Create a new FileProperties without any defined properties.

Parameters:

name - the name of the tab

comp - the component associated with the tab

FileProperties

public FileProperties(java.lang.String name,
                      C comp,
                      boolean isCloseable)

Create a new FileProperties without any defined properties.

Parameters:

name - the name of the tab

comp - the component associated with the tab

isCloseable - true if the tab is closeable

FileProperties

public FileProperties(java.lang.String name,
                      C comp,
                      boolean isCloseable,
                      boolean isEditable)

Create a new FileProperties without any defined properties.

Parameters:

name - the name of the tab

comp - the component associated with the tab

isCloseable - true if the tab is closeable

isEditable - true if the tab is editable

FileProperties

public FileProperties(java.lang.String name,
                      C comp,
                      java.lang.Object obj)

Create a new FileProperties without any defined properties, and associate it with an Object.

Parameters:

name - the name of the tab

comp - the component associated with the tab

obj - the associated Object

FileProperties

public FileProperties(java.lang.String name,
                      C comp,
                      java.lang.Object obj,
                      boolean isCloseable)

Create a new FileProperties without any defined properties, and associate it with an Object.

Parameters:

name - the name of the tab

comp - the component associated with the tab

obj - the associated Object

isCloseable - true if the tab is closeable

FileProperties

public FileProperties(java.lang.String name,
                      C comp,
                      java.lang.Object obj,
                      boolean isCloseable,
                      boolean isEditable)

Create a new FileProperties without any defined properties, and associate it with an Object.

Parameters:

name - the name of the tab

comp - the component associated with the tab

obj - the associated Object

isCloseable - true if the tab is closeable

isEditable - true if the tab is editable

FileProperties

public FileProperties(java.lang.String name,
                      C comp,
                      java.lang.Object obj,
                      MetaData properties)

Create a new FileProperties with some defined properties, and associate it with an Object.

Parameters:

name - the name of the tab

comp - the component associated with the tab

obj - the associated Object

properties - the associated MetaData

FileProperties

public FileProperties(java.lang.String name,
                      C comp,
                      java.lang.Object obj,
                      MetaData properties,
                      boolean isCloseable,
                      boolean isEditable)

Create a new FileProperties with some defined properties, and associate it with an Object.

Parameters:

name - the name of the tab

comp - the component associated with the tab

obj - the associated Object

properties - the associated MetaData

isCloseable - true if the tab is closeable

isEditable - true if the tab is editable *

Method Detail

getName

public java.lang.String getName()

Return the name of the panel.

Returns:

the name of the panel

setName

public void setName(java.lang.String name)

Set the name of the panel.

Parameters:

name - the name of the panel

setCloseable

public void setCloseable(boolean isCloseable)

Set if the associated tab is closeable.

Parameters:

isCloseable - true if the associated tab is closeable

isCloseable

public boolean isCloseable()

Return true if the associated tab is closeable.

Returns:

true if the associated tab is closeable

setEditable

public void setEditable(boolean isEditable)

Set if the associated tab message area is isEditable.

Parameters:

isEditable - true if the associated tab message area is isEditable

isEditable

public boolean isEditable()

Return true if the associated tab message area is isEditable.

Returns:

true if the associated tab message area is isEditable

getComponent

public C getComponent()

Return the FileProperties associated panel.

Returns:

the FileProperties associated panel

getMetaData

public MetaData getMetaData()

Return the MetaData associated with the panel.

Returns:

the MetaData associated with the panel

setMetaData

public void setMetaData(MetaData properties)

Set the MetaData to associate with the panel.

Parameters:

properties - the MetaData to associate with the panel

getObject

public java.lang.Object getObject()

Return the associated Object, if it exists, or else return null.

Returns:

the associated Object

setObject

public void setObject(java.lang.Object obj)

Set the associated Object.

Parameters:

obj - the associated Object

setURL

public void setURL(java.net.URL url)

Set the associated URL.

Parameters:

url - the url

getURL

public java.net.URL getURL()

Return the associated URL (may be null).

Returns:

the url

getFile

public java.io.File getFile()

Return the associated File (may be null).

Returns:

the file

isCompatibleWith

public boolean isCompatibleWith(MetaData meta,
                                boolean complete)

Look if two FileProperties are compatible. This method redirect to the FileProperties MetaData if it exist, else it will return true.

Parameters:

meta - the MetaData to compare with

complete - true if there must be equality for the MetaData keys, meaning that all properties in each MetaData must match, false if only the keys of the MetaData to compare must match

Returns:

true if the two FileProperties are compatible

isCompatibleWith

public boolean isCompatibleWith(FileProperties prop,
                                boolean complete)

Look if two FileProperties are compatible. This method redirect to the FileProperties MetaData if it exist, else it will return true.

Parameters:

prop - the second FileProperties

complete - true if there must be equality for the MetaData keys, meaning that all properties in each MetaData must match, false if only the keys of the MetaData to compare must match

Returns:

true if the two FileProperties are compatible

isCompatibleWith

public boolean isCompatibleWith(MetaData meta)

Same as isCompatibleWith(MetaData, boolean), with only partial compatibility. Only the keys of the MetaData to compare must match, meaning that there can be additional keys in this FileProperties MetaData.

Parameters:

meta - the MetaData to compare with

Returns:

true if the two FileProperties are compatible (partial compatibility)

isCompatibleWith

public boolean isCompatibleWith(FileProperties prop)

Same as isCompatibleWith(org.mdi.bootstrap.FileProperties, boolean), with only partial compatibility. Only the keys of the MetaData to compare must match, meaning that there can be additional keys in this FileProperties MetaData.

Parameters:

prop - the second FileProperties

Returns:

true if the two FileProperties are compatible