Package com.intellij.ide.projectView

Class PresentationData

java.lang.Object

com.intellij.ide.projectView.PresentationData

All Implemented Interfaces:

ColoredItemPresentation, ItemPresentation, LocationPresentation, ComparableObject

public class PresentationData
extends java.lang.Object
implements ColoredItemPresentation, ComparableObject, LocationPresentation

Default implementation of the ItemPresentation interface.

Nested Class Summary

Nested classes/interfaces inherited from interface com.intellij.util.ui.update.ComparableObject

ComparableObject.Impl

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<PresentableNodeDescriptor.ColoredFragment>	myColoredText

Fields inherited from interface com.intellij.util.ui.update.ComparableObject

NONE

Fields inherited from interface com.intellij.navigation.LocationPresentation

DEFAULT_LOCATION_PREFIX, DEFAULT_LOCATION_SUFFIX

Constructor Summary

Constructors

Constructor and Description
PresentationData() Creates an instance with no parameters specified.
PresentationData(java.lang.String presentableText, java.lang.String locationString, javax.swing.Icon openIcon, javax.swing.Icon closedIcon, TextAttributesKey attributesKey) Deprecated. Use PresentationData(String, String, Icon, TextAttributesKey) instead.
PresentationData(java.lang.String presentableText, java.lang.String locationString, javax.swing.Icon icon, TextAttributesKey attributesKey) Creates an instance with the specified parameters.

Method Summary

Modifier and Type	Method and Description
void	addText(PresentableNodeDescriptor.ColoredFragment coloredFragment)
void	addText(java.lang.String text, SimpleTextAttributes attributes)
void	applyFrom(PresentationData from)
void	clear()
void	clearText()
PresentationData	clone()
void	copyFrom(PresentationData from)
boolean	equals(java.lang.Object obj)
java.util.List<PresentableNodeDescriptor.ColoredFragment>	getColoredText()
java.lang.Object []	getEqualityObjects()
java.awt.Color	getForcedTextForeground()
javax.swing.Icon	getIcon(boolean open) Returns the icon representing the object.
java.lang.String	getLocationPrefix()
java.lang.String	getLocationString() Returns the location of the object (for example, the package of a class).
java.lang.String	getLocationSuffix()
java.lang.String	getPresentableText() Returns the name of the object to be presented in most renderers across the program.
TextAttributesKey	getTextAttributesKey() Returns the text attributes for rendering the item text.
java.lang.String	getTooltip()
int	hashCode()
boolean	hasSeparatorAbove()
boolean	isChanged()
void	setAttributesKey(TextAttributesKey attributesKey) Sets the attributes for rendering the item text.
void	setChanged(boolean changed)
void	setClosedIcon(javax.swing.Icon closedIcon) Deprecated. Different icons for open/closed no longer supported. Use setIcon instead Sets the icon shown for the node when it is collapsed in a tree, or when it is displayed in a non-tree view.
void	setForcedTextForeground(java.awt.Color forcedTextForeground)
void	setIcon(javax.swing.Icon icon)
void	setIcons(javax.swing.Icon icon) Deprecated. Different icons for open/closed no longer supported. Use setIcon instead. Sets both the open and closed icons of the node to the specified icon.
void	setLocationString(java.lang.String locationString) Sets the location of the object (for example, the package of a class).
void	setOpenIcon(javax.swing.Icon openIcon) Deprecated. Different icons for open/closed no longer supported. This function is no op. Sets the icon shown for the node when it is expanded in the tree.
void	setPresentableText(java.lang.String presentableText) Sets the name of the object to be presented in most renderers across the program.
void	setSeparatorAbove(boolean b)
void	setTooltip(java.lang.String tooltip)
void	updateFrom(ItemPresentation presentation) Copies the presentation parameters from the specified presentation instance.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

myColoredText

protected final java.util.List<PresentableNodeDescriptor.ColoredFragment> myColoredText

Constructor Detail

PresentationData

public PresentationData(java.lang.String presentableText,
                        java.lang.String locationString,
                        javax.swing.Icon icon,
                        TextAttributesKey attributesKey)

Creates an instance with the specified parameters.

Parameters:

presentableText - the name of the object to be presented in most renderers across the program.

locationString - the location of the object (for example, the package of a class). The location string is used by some renderers and usually displayed as grayed text next to the item name.

icon - the icon shown for the node when it is collapsed in a tree, or when it is displayed in a non-tree view.

attributesKey - the attributes for rendering the item text.

PresentationData

@Deprecated
public PresentationData(java.lang.String presentableText,
                        java.lang.String locationString,
                        javax.swing.Icon openIcon,
                        javax.swing.Icon closedIcon,
                        TextAttributesKey attributesKey)

Deprecated. Use PresentationData(String, String, Icon, TextAttributesKey) instead.

PresentationData

public PresentationData()

Creates an instance with no parameters specified.

Method Detail

getIcon

public javax.swing.Icon getIcon(boolean open)

Description copied from interface: ItemPresentation

Returns the icon representing the object.

Specified by:

getIcon in interface ItemPresentation

Parameters:

open - Used to mean if open/close icons for tree renderer. No longer in use. The parameter is only there for API compatibility reason.

getForcedTextForeground

public java.awt.Color getForcedTextForeground()

setForcedTextForeground

public void setForcedTextForeground(java.awt.Color forcedTextForeground)

getLocationString

public java.lang.String getLocationString()

Description copied from interface: ItemPresentation

Returns the location of the object (for example, the package of a class). The location string is used by some renderers and usually displayed as grayed text next to the item name.

Specified by:

getLocationString in interface ItemPresentation

Returns:

the location description, or null if none is applicable.

getPresentableText

public java.lang.String getPresentableText()

Description copied from interface: ItemPresentation

Returns the name of the object to be presented in most renderers across the program.

Specified by:

getPresentableText in interface ItemPresentation

Returns:

the object name.

setIcon

public void setIcon(javax.swing.Icon icon)

setLocationString

public void setLocationString(java.lang.String locationString)

Sets the location of the object (for example, the package of a class). The location string is used by some renderers and usually displayed as grayed text next to the item name.

Parameters:

locationString - the location of the object.

setPresentableText

public void setPresentableText(java.lang.String presentableText)

Sets the name of the object to be presented in most renderers across the program.

Parameters:

presentableText - the name of the object.

setClosedIcon

@Deprecated
public void setClosedIcon(javax.swing.Icon closedIcon)

Deprecated. Different icons for open/closed no longer supported. Use setIcon instead Sets the icon shown for the node when it is collapsed in a tree, or when it is displayed in a non-tree view.

Parameters:

closedIcon - the closed icon for the node.

See Also:

setIcons(Icon)

setOpenIcon

@Deprecated
public void setOpenIcon(javax.swing.Icon openIcon)

Deprecated. Different icons for open/closed no longer supported. This function is no op. Sets the icon shown for the node when it is expanded in the tree.

Parameters:

openIcon - the open icon for the node.

See Also:

setIcons(Icon)

setIcons

@Deprecated
public void setIcons(javax.swing.Icon icon)

Deprecated. Different icons for open/closed no longer supported. Use setIcon instead. Sets both the open and closed icons of the node to the specified icon.

Parameters:

icon - the icon for the node.

See Also:

setOpenIcon(Icon), setClosedIcon(Icon)

updateFrom

public void updateFrom(ItemPresentation presentation)

Copies the presentation parameters from the specified presentation instance.

Parameters:

presentation - the instance to copy the parameters from.

hasSeparatorAbove

public boolean hasSeparatorAbove()

setSeparatorAbove

public void setSeparatorAbove(boolean b)

getTextAttributesKey

public TextAttributesKey getTextAttributesKey()

Description copied from interface: ColoredItemPresentation

Returns the text attributes for rendering the item text.

Specified by:

getTextAttributesKey in interface ColoredItemPresentation

Returns:

the text attributes, or null if default text attributes should be used

setAttributesKey

public void setAttributesKey(TextAttributesKey attributesKey)

Sets the attributes for rendering the item text.

Parameters:

attributesKey - the attributes for rendering the item text.

getTooltip

public java.lang.String getTooltip()

setTooltip

public void setTooltip(java.lang.String tooltip)

isChanged

public boolean isChanged()

setChanged

public void setChanged(boolean changed)

getColoredText

public java.util.List<PresentableNodeDescriptor.ColoredFragment> getColoredText()

addText

public void addText(PresentableNodeDescriptor.ColoredFragment coloredFragment)

addText

public void addText(java.lang.String text,
                    SimpleTextAttributes attributes)

clearText

public void clearText()

clear

public void clear()

getEqualityObjects

public java.lang.Object [] getEqualityObjects()

Specified by:

getEqualityObjects in interface ComparableObject

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

copyFrom

public void copyFrom(PresentationData from)

clone

public PresentationData clone()

Overrides:

clone in class java.lang.Object

applyFrom

public void applyFrom(PresentationData from)

getLocationPrefix

public java.lang.String getLocationPrefix()

Specified by:

getLocationPrefix in interface LocationPresentation

getLocationSuffix

public java.lang.String getLocationSuffix()

Specified by:

getLocationSuffix in interface LocationPresentation