|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.ibm.portal.theme.plugin.impl.DefaultThemeContent com.ibm.portal.theme.plugin.impl.DefaultThemeItem com.ibm.portal.theme.plugin.impl.DefaultThemeLinkItem
public class DefaultThemeLinkItem
Creates a link to a portal page. This extension will parse the plugin.xml and create a link to the specified content node.
This class may be sub-classed by developers.
Markup description:
Element name: item
Attributes:
This interface is designed to be implemented by clients. |
Field Summary | |
---|---|
static java.lang.String |
CONTENT_NODE_ATTRIBUTE
The CONTENT_NODE_ATTRIBUTE indicates the content node
in the navigation model that we want to generate a URL to. |
static java.lang.String |
NEW_WINDOW_ATTRIBUTE
The NEW_WINDOW_ATTRIBUTE indicates whether the url
should be opened in a new window or not. |
Fields inherited from class com.ibm.portal.theme.plugin.impl.DefaultThemeItem |
---|
ICON_NAME_ATTRIBUTE, iconName, state |
Fields inherited from class com.ibm.portal.theme.plugin.impl.DefaultThemeContent |
---|
context, description, ordinal, title |
Fields inherited from interface com.ibm.portal.theme.plugin.impl.ThemeItemDescriptorConstants |
---|
ELEMENT_NAME, TOOLTIP_ATTRIBUTE |
Fields inherited from interface com.ibm.portal.theme.plugin.impl.ThemeContentDescriptorConstants |
---|
CLASS_ATTRIBUTE, DESCR_ATTRIBUTE, ID_ATTRIBUTE, ORDINAL_ATTRIBUTE, TITLE_ATTRIBUTE |
Constructor Summary | |
---|---|
DefaultThemeLinkItem()
|
Method Summary | |
---|---|
java.lang.String |
getDescription(java.util.Locale arg0)
Returns the description of this object in the given locale. |
ListModel |
getLocales()
Returns a list model containing the locales that are supported by this object. |
int |
getOrdinal()
Gets the ordinal value. |
java.lang.String |
getTitle(java.util.Locale arg0)
Returns the title of this object in the given locale. |
java.lang.String |
getTooltip(java.util.Locale locale)
Returns the tooltip text for the current locale. |
boolean |
isActive()
|
boolean |
isNewWindow()
Indicates if the URL should be opened in a new browser window or not. |
com.ibm.portal.state.EngineURL |
newURL()
Returns the generated URL. |
boolean |
requiresPOST()
If the URL is an action, it should be rendered as a FORM POST instead of the usual GET. |
void |
setInitializationData(org.eclipse.core.runtime.IConfigurationElement element,
java.lang.String arg1,
java.lang.Object arg2)
|
Methods inherited from class com.ibm.portal.theme.plugin.impl.DefaultThemeItem |
---|
createIconFilename, getIconDirectoryPath, getIconFileName, getIconStateValue, getStateValue, newIconURL |
Methods inherited from class com.ibm.portal.theme.plugin.impl.DefaultThemeContent |
---|
getRequest, getResponse, init |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.ibm.portal.theme.plugin.ThemeItem |
---|
newIconURL |
Methods inherited from interface com.ibm.portal.theme.plugin.ThemeContent |
---|
init |
Field Detail |
---|
public static final java.lang.String CONTENT_NODE_ATTRIBUTE
CONTENT_NODE_ATTRIBUTE
indicates the content node
in the navigation model that we want to generate a URL to.
public static final java.lang.String NEW_WINDOW_ATTRIBUTE
NEW_WINDOW_ATTRIBUTE
indicates whether the url
should be opened in a new window or not.
Constructor Detail |
---|
public DefaultThemeLinkItem()
Method Detail |
---|
public void setInitializationData(org.eclipse.core.runtime.IConfigurationElement element, java.lang.String arg1, java.lang.Object arg2) throws org.eclipse.core.runtime.CoreException
setInitializationData
in interface org.eclipse.core.runtime.IExecutableExtension
setInitializationData
in class DefaultThemeItem
org.eclipse.core.runtime.CoreException
public com.ibm.portal.state.EngineURL newURL() throws com.ibm.portal.state.exceptions.StateException
ThemeLinkItem
null
value is
returned.
newURL
in interface ThemeLinkItem
newURL
in class DefaultThemeItem
null
com.ibm.portal.state.exceptions.StateException
- if an error occurs creating the URLpublic java.lang.String getTitle(java.util.Locale arg0)
Localized
getTitle
in interface Localized
getTitle
in class DefaultThemeContent
arg0
- the locale for which to retrieve the title, must not
be null
.
null
.
It is up to the invoker of the method to implement an appropriate
fallback mechanism.public java.lang.String getDescription(java.util.Locale arg0)
Localized
getDescription
in interface Localized
getDescription
in class DefaultThemeContent
arg0
- the locale for which to retrieve the description, must not
be null
.
null
.
It is up to the invoker of the method to implement an appropriate
fallback mechanismpublic ListModel getLocales()
Localized
getLocales
in interface Localized
getLocales
in class DefaultThemeContent
ListModel
if no locales are supported.public java.lang.String getTooltip(java.util.Locale locale)
ThemeItem
null
if the tooltip text doesn't
exist for the specified locale or if an error occurs.
getTooltip
in interface ThemeItem
getTooltip
in class DefaultThemeContent
locale
- the current locale
null
public boolean requiresPOST()
ThemeLinkItem
requiresPOST
in interface ThemeLinkItem
requiresPOST
in class DefaultThemeItem
true
if the URL is an actionpublic int getOrdinal()
ThemeContent
getOrdinal
in interface ThemeContent
getOrdinal
in class DefaultThemeContent
public boolean isNewWindow()
ThemeLinkItem
isNewWindow
in interface ThemeLinkItem
true
if the URL should be opened in a new windowpublic boolean isActive() throws ModelException
isActive
in interface com.ibm.portal.ActiveFlag
isActive
in class DefaultThemeContent
ModelException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |