ro.sync.exml.workspace.api.standalone.project

Class ProjectRendererCustomizer

java.lang.Object

ro.sync.exml.workspace.api.standalone.project.ProjectRendererCustomizer

@API(type=EXTENDABLE,
     src=PUBLIC)
public abstract class ProjectRendererCustomizer
extends java.lang.Object

Base class which can be extended to customize the rendering of the files from the Project view in the stand-alone Oxygen installation.

Since:

20

Constructor Summary

Constructors

Constructor and Description
ProjectRendererCustomizer()

Method Summary

Modifier and Type	Method and Description
javax.swing.Icon	getDecorationIcon(java.io.File projectFile) Get the decoration icon for a certain file shown in the Project view.
java.lang.String	getName(java.io.File projectFile, java.lang.String defaultName) Get the custom name for a certain file shown in the Project view.
java.lang.String	getTooltip(java.io.File projectFile, java.lang.String defaultTooltip) Get the custom tooltip for a certain file shown in the Project view.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProjectRendererCustomizer

public ProjectRendererCustomizer()

Method Detail

getDecorationIcon

public javax.swing.Icon getDecorationIcon(java.io.File projectFile)

Get the decoration icon for a certain file shown in the Project view. This callback comes very often, each time the Project Swing JTree is repainted, so the developers implementing it need to develop their own internal caches.

Parameters:

projectFile - The file in the Project view.

Returns:

the decoration icon or null if the default should be used instead. The decoration icon should be about 10x10 pixels.

getTooltip

public java.lang.String getTooltip(java.io.File projectFile,
                                   java.lang.String defaultTooltip)

Get the custom tooltip for a certain file shown in the Project view. This callback comes very often, each time the Project Swing JTree is repainted, so the developers implementing it need to develop their own internal caches.

Parameters:

projectFile - The file in the Project view.

defaultTooltip - The default tooltip.

Returns:

the custom tooltip for a certain File shown in the Project view or null if the default should be used instead.

getName

public java.lang.String getName(java.io.File projectFile,
                                java.lang.String defaultName)

Get the custom name for a certain file shown in the Project view. This callback comes very often, each time the Project Swing JTree is repainted, so the developers implementing it need to develop their own internal caches.

Parameters:

projectFile - The file in the Project view.

defaultName - The default name.

Returns:

the custom name for a certain File shown in the Project view or null if the default should be used instead.