oracle.ide.model
Class DocumentInfo

java.lang.Object
  oracle.ide.model.DocumentInfo

public final class DocumentInfo

extends java.lang.Object

DocumentInfo class. Stores information about a given document type. Such information includes: the icon representing the document type, and the document type display label.

Constructor Summary

DocumentInfo(java.lang.String label)
Create a DocumentInfo instance.

DocumentInfo(java.lang.String label, ArrayResourceBundle bundle, int key)
Create a DocumentInfo instance.

DocumentInfo(java.lang.String label, boolean hidden)
Create a DocumentInfo instance indicating whether the document type should not be shown in the node type preference panel.

DocumentInfo(java.lang.String label, javax.swing.Icon icon)
Create a DocumentInfo instance.

DocumentInfo(java.lang.String label, java.util.ResourceBundle bundle, java.lang.String key)
Create a DocumentInfo instance.

Method Summary

javax.swing.Icon	getIcon() Get the icon property, performing delayed resource fetch if necessary.
java.lang.String	getLabel() Get the label property.
boolean	isHidden() Get the hidden state of the node type.
boolean	isIconSpecified() Returns true if the icon is set or an access mechanism has been specified.
void	setIcon(ArrayResourceBundle bundle, int key) Set icon property such that resource fetch is postponed until needed.
void	setIcon(java.lang.Class iconNodeClass) Set icon property such that resource fetch is postponed until needed.
void	setIcon(javax.swing.Icon icon) Set icon property.
void	setIcon(java.util.ResourceBundle bundle, java.lang.String key) Set icon property such that resource fetch is postponed until needed.
void	setLabel(java.lang.String label) Set the label property.

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentInfo

public DocumentInfo(java.lang.String label)

Create a DocumentInfo instance. Recommended constructor. The icon information will be determined from the document instance.

Parameters:

label - a short label describing the document type.

DocumentInfo

public DocumentInfo(java.lang.String label,
                    boolean hidden)

Create a DocumentInfo instance indicating whether the document type should not be shown in the node type preference panel.

Parameters:

label - a short label describing the document type.

hidden - when true indicates that the node type should not be shown in the node type preference panel.

DocumentInfo

public DocumentInfo(java.lang.String label,
                    javax.swing.Icon icon)

Create a DocumentInfo instance. This constructor is not recommended. The icon need not be specified it can be determined from the document itself. If you need to specify a different icon use the constructor that takes the resource bundle and resource key as argument.

Parameters:

label - a short label describing the document type.

icon - iconic representation of the document type.

DocumentInfo

public DocumentInfo(java.lang.String label,
                    ArrayResourceBundle bundle,
                    int key)

Create a DocumentInfo instance. This constructor is not recommended. The icon need not be specified it can be determined from the document itself. Use the constructor that takes the label only.

Parameters:

label - a short label describing the document type.

bundle - the array resource bundle.

key - a key pointing to the icon information in the resource bundle.

DocumentInfo

public DocumentInfo(java.lang.String label,
                    java.util.ResourceBundle bundle,
                    java.lang.String key)

Create a DocumentInfo instance. This constructor is not recommended. The icon need not be specified it can be determined from the document itself. Use the constructor that takes the label only.

Parameters:

label - a short label describing the document type.

bundle - the resource bundle.

key - a key pointing to the icon information in the resource bundle.

Method Detail

getLabel

public java.lang.String getLabel()

Get the label property.

setLabel

public void setLabel(java.lang.String label)

Set the label property.

isIconSpecified

public boolean isIconSpecified()

Returns true if the icon is set or an access mechanism has been specified.

Returns:

true if the icon is set or an access mechanism has been specified

getIcon

public javax.swing.Icon getIcon()

Get the icon property, performing delayed resource fetch if necessary.

setIcon

public void setIcon(javax.swing.Icon icon)

Set icon property. For performance reasons, users of ArrayResourceBundle are encouraged to use the version which takes a bundle and key instead.

See Also:

setIcon(ArrayResourceBundle, int)

setIcon

public void setIcon(ArrayResourceBundle bundle,
                    int key)

Set icon property such that resource fetch is postponed until needed.

See Also:

getIcon()

setIcon

public void setIcon(java.util.ResourceBundle bundle,
                    java.lang.String key)

Set icon property such that resource fetch is postponed until needed.

See Also:

getIcon()

setIcon

public void setIcon(java.lang.Class iconNodeClass)

Set icon property such that resource fetch is postponed until needed.

See Also:

getIcon()

isHidden

public boolean isHidden()

Get the hidden state of the node type. Default value is false.

Returns:

true indicates that the node type should not be shown in the node types preference panel.