oracle.adf.share.services
Interface URLDescriptor

public interface URLDescriptor

Method Summary

java.lang.String	getDisplayName() Returns the item's display name within the parent that can be used when rendering the current item.
javax.swing.Icon	getIcon() Returns an icon that can be used when rendering the current item.
java.lang.String	getLongLabel() Returns a long label that can be used when rendering the current item.
java.lang.String	getName() Returns the identifying jndi name within the strategy (or context) parent.
java.lang.String	getShortLabel() Returns a short label that can be used when rendering the current item.
java.lang.String	getToolTipText() Returns ToolTip text that can be displayed by a client when they mouse over the current item in a user interface.
java.net.URL	getUrl() Returns the real (and complete, but possibly logical) URL for this resource.

Method Detail

getUrl

java.net.URL getUrl()

Returns the real (and complete, but possibly logical) URL for this resource. Ex: jar:file:/jarpath/jarfile.jar!/elempath/foo.bar#multipart.itemname

getName

java.lang.String getName()

Returns the identifying jndi name within the strategy (or context) parent. Ex: multipart.itemname or just itemname if multipart is a context.

getDisplayName

java.lang.String getDisplayName()

Returns the item's display name within the parent that can be used when rendering the current item.

getShortLabel

java.lang.String getShortLabel()

Returns a short label that can be used when rendering the current item. May even be shorter than getDisplayName. Ex: itemname

getLongLabel

java.lang.String getLongLabel()

Returns a long label that can be used when rendering the current item. Most likely this is the suffix of getUrl() within the container (jar). Ex: elempath/foo.bar#multipart.itemname

getToolTipText

java.lang.String getToolTipText()

Returns ToolTip text that can be displayed by a client when they mouse over the current item in a user interface. Likely some form of getLongLabel().

getIcon

javax.swing.Icon getIcon()

Returns an icon that can be used when rendering the current item.