public interface KomodoObjectLabelProvider
KomodoObject
s.Modifier and Type | Interface and Description |
---|---|
static interface |
KomodoObjectLabelProvider.Settings
Display settings.
|
Modifier and Type | Method and Description |
---|---|
String |
getDisplayName(Repository.UnitOfWork transaction,
KomodoObject kobject,
TextFormat format)
If necessary, removes the namespace prefix from the name.
|
String |
getDisplayPath(Repository.UnitOfWork transaction,
KomodoObject kobject,
TextFormat format) |
String |
getDisplayPath(Repository.UnitOfWork transaction,
String repositoryAbsolutePath,
TextFormat format) |
String |
getId() |
String |
getPath(Repository.UnitOfWork transaction,
String displayPath) |
String |
getTypeDisplay(Repository.UnitOfWork transaction,
KomodoObject kobject,
TextFormat format)
Get the type display string for a KomodoObject
|
String |
getWorkspacePath() |
boolean |
isWorkspacePath(String path) |
void |
setPropertyProvider(PropertyProvider propertyProvider) |
void |
setRepository(Repository repository,
Repository.UnitOfWork transaction)
This method will be called by the Komodo shell framework and should not be called.
|
void |
setWorkspacePath(Repository.UnitOfWork transaction)
Set the path to the workspace using the username available from the transaction
|
List<String> |
skippedPathSegmentNames() |
String getWorkspacePath()
void setWorkspacePath(Repository.UnitOfWork transaction)
transaction
- boolean isWorkspacePath(String path)
path
- String getDisplayName(Repository.UnitOfWork transaction, KomodoObject kobject, TextFormat format)
transaction
- the transaction (never null
and must have a state of Repository.UnitOfWork.State.NOT_STARTED
)kobject
- the repository path whose display name is being requested (cannot be null
)format
- the text formatting (can be null
if no formatting will be done)String getDisplayPath(Repository.UnitOfWork transaction, KomodoObject kobject, TextFormat format)
transaction
- the transaction (never null
and must have a state of Repository.UnitOfWork.State.NOT_STARTED
)kobject
- the object whose whose repository display path is being requested (cannot be null
)format
- the text formatting (can be null
if no formatting will be done)String getDisplayPath(Repository.UnitOfWork transaction, String repositoryAbsolutePath, TextFormat format)
transaction
- the transaction (never null
and must have a state of Repository.UnitOfWork.State.NOT_STARTED
)repositoryAbsolutePath
- the path of the object whose whose repository display path is being requested (cannot be empty)format
- the text formatting (can be null
if no formatting will be done)String getId()
String getPath(Repository.UnitOfWork transaction, String displayPath)
transaction
- the transaction (never null
and must have a state of Repository.UnitOfWork.State.NOT_STARTED
)displayPath
- the display path whose repository path is being requested (cannot be empty)String getTypeDisplay(Repository.UnitOfWork transaction, KomodoObject kobject, TextFormat format)
transaction
- the transaction (never null
and must have a state of Repository.UnitOfWork.State.NOT_STARTED
)kobject
- the KomodoObject (never null
)format
- the text formatting (can be null
if no formatting will be done)null
if unable to provide type display)void setPropertyProvider(PropertyProvider propertyProvider)
propertyProvider
- the property provider (cannot be null
)void setRepository(Repository repository, Repository.UnitOfWork transaction) throws KException
repository
- the repository whose paths and display paths will be provided (never null
)transaction
- the transaction holding the prospective userKException
- if error occursCopyright © 2013–2019. All rights reserved.