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 and Description |
---|
DocumentInfo(java.lang.String label)
Create a
DocumentInfo instance. |
DocumentInfo(java.lang.String label, ArrayResourceBundle bundle, int key)
Deprecated.
since 11.1.1 use
DocumentInfo(String,Icon) . Internal components should use OracleIcons to ensure that the icon is loaded lazily. |
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)
Deprecated.
since 11.1.1 use
DocumentInfo(String,Icon) . Internal components should use OracleIcons to ensure that the icon is loaded lazily. |
Modifier and Type | Method and Description |
---|---|
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.
|
public DocumentInfo(java.lang.String label)
DocumentInfo
instance. Recommended constructor. The icon information will be determined from the document instance.label
- a short label describing the document type.public DocumentInfo(java.lang.String label, boolean hidden)
DocumentInfo
instance indicating whether the document type should not be shown in the node type preference panel.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.public DocumentInfo(java.lang.String label, javax.swing.Icon icon)
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.label
- a short label describing the document type.icon
- iconic representation of the document type.public DocumentInfo(java.lang.String label, ArrayResourceBundle bundle, int key)
DocumentInfo(String,Icon)
. Internal components should use OracleIcons
to ensure that the icon is loaded lazily.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.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.public DocumentInfo(java.lang.String label, java.util.ResourceBundle bundle, java.lang.String key)
DocumentInfo(String,Icon)
. Internal components should use OracleIcons
to ensure that the icon is loaded lazily.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.label
- a short label describing the document type.bundle
- the resource bundle.key
- a key pointing to the icon information in the resource bundle.public java.lang.String getLabel()
public void setLabel(java.lang.String label)
public boolean isIconSpecified()
public javax.swing.Icon getIcon()
public void setIcon(javax.swing.Icon icon)
setIcon(ArrayResourceBundle, int)
public void setIcon(ArrayResourceBundle bundle, int key)
getIcon()
public void setIcon(java.util.ResourceBundle bundle, java.lang.String key)
getIcon()
public void setIcon(java.lang.Class iconNodeClass)
getIcon()
public boolean isHidden()
false
.true
indicates that the node type should not be shown in the node types preference panel.