org.kuali.rice.kns.datadictionary
Class HeaderNavigation

java.lang.Object
  org.kuali.rice.kns.datadictionary.DataDictionaryDefinitionBase
      org.kuali.rice.kns.datadictionary.HeaderNavigation

All Implemented Interfaces:

Serializable, DataDictionaryDefinition, org.springframework.beans.factory.InitializingBean

public class HeaderNavigation
extends DataDictionaryDefinitionBase
implements Serializable

The headerNavigation element defines a set of additional tabs which will appear on the document. The headerNavigationTab defines an additional tab which will appear on the document.

See Also:

Serialized Form

Field Summary

protected boolean	disabled
protected String	headerTabDisplayName
protected String	headerTabMethodToCall
protected String	headerTabNavigateTo
protected HelpDefinition	helpDefinition
private static long	serialVersionUID

Fields inherited from class org.kuali.rice.kns.datadictionary.DataDictionaryDefinitionBase

id

Constructor Summary

HeaderNavigation()

HeaderNavigation(String headerTabNavigateTo, String headerTabDisplayName)

Method Summary

void	completeValidation(Class rootBusinessObjectClass, Class otherBusinessObjectClass) Performs complete intra-definition validation which couldn't be done earlier - for example, verifies that field references refer to actual fields of some specific class.
String	getHeaderTabDisplayName() Gets the navigationStyle attribute.
String	getHeaderTabMethodToCall() Gets the navigationKey attribute.
String	getHeaderTabNavigateTo() Gets the suffix attribute.
HelpDefinition	getHelpDefinition()
boolean	isDisabled()
void	setDisabled(boolean disabled)
void	setHeaderTabDisplayName(String headerTabDisplayName) The displayName element is the name of the additional tab.
void	setHeaderTabMethodToCall(String navigationKey) Sets the navigationKey attribute value.
void	setHeaderTabNavigateTo(String suffix) The navigateTo element is the forward name in the struts-config file.
void	setHelpDefinition(HelpDefinition helpDefinition) The pageHelp element provides the keys to obtain a help description from the database.

Methods inherited from class org.kuali.rice.kns.datadictionary.DataDictionaryDefinitionBase

afterPropertiesSet, getId, setId

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

headerTabMethodToCall

protected String headerTabMethodToCall

headerTabNavigateTo

protected String headerTabNavigateTo

headerTabDisplayName

protected String headerTabDisplayName

helpDefinition

protected HelpDefinition helpDefinition

disabled

protected boolean disabled

Constructor Detail

HeaderNavigation

public HeaderNavigation()

HeaderNavigation

public HeaderNavigation(String headerTabNavigateTo,
                        String headerTabDisplayName)

Method Detail

getHeaderTabMethodToCall

public String getHeaderTabMethodToCall()

Gets the navigationKey attribute.

Returns:

Returns the navigationKey.

setHeaderTabMethodToCall

public void setHeaderTabMethodToCall(String navigationKey)

Sets the navigationKey attribute value.

Parameters:

navigationKey - The navigationKey to set.

getHeaderTabDisplayName

public String getHeaderTabDisplayName()

Gets the navigationStyle attribute.

Returns:

Returns the navigationStyle.

setHeaderTabDisplayName

public void setHeaderTabDisplayName(String headerTabDisplayName)

The displayName element is the name of the additional tab.

getHeaderTabNavigateTo

public String getHeaderTabNavigateTo()

Gets the suffix attribute.

Returns:

Returns the suffix.

getHelpDefinition

public HelpDefinition getHelpDefinition()

setHelpDefinition

public void setHelpDefinition(HelpDefinition helpDefinition)

The pageHelp element provides the keys to obtain a help description from the database. On document JSP pages, a help icon may be rendered. If this tag is specified, then the filename of this page will be located in the value of the parameter specified by the namespace, detail type, and name. The value of the parameter is relative to the value of the "externalizable.help.url" property in KualiConfigurationService (see KualiHelpAction). parameterNamespace: namespace of the parameter that has the path to the help page parameterName: name of the parameter that has the path to the help page parameterDetailType: detail type of the parameter that has the path to the help page

setHeaderTabNavigateTo

public void setHeaderTabNavigateTo(String suffix)

The navigateTo element is the forward name in the struts-config file.

isDisabled

public boolean isDisabled()

setDisabled

public void setDisabled(boolean disabled)

completeValidation

public void completeValidation(Class rootBusinessObjectClass,
                               Class otherBusinessObjectClass)

Description copied from interface: DataDictionaryDefinition

Performs complete intra-definition validation which couldn't be done earlier - for example, verifies that field references refer to actual fields of some specific class.

Specified by:

completeValidation in interface DataDictionaryDefinition

Parameters:

rootBusinessObjectClass - Class of the BusinessObjectEntry which ultimately contains this definition

otherBusinessObjectClass - other stuff required to complete validation

See Also:

DataDictionaryDefinition.completeValidation(java.lang.Class, java.lang.Class)