Documentation Archive Developer
Search
PATH Documentation > WebObjects

Up

D2WComponent

Package: com.webobjects.directtoweb

Inherits from:com.webobjects.appserver.WOComponent

Subclasses:

Class Description

This class is the parent class for the Direct to Web templates and the property-level components. These components all access a Direct to Web context with the d2wContext method. The D2WComponent class also defines several keys that are used in the binding (.wod) files for the Direct to Web templates. In addition, D2WComponent defines an action method, showWebAssistant, that opens the Web Assistant in the user's browser.

Method Types

Constructors
Static Constants

Actions
Key-Value Coding
Private Methods

Constructors

D2WComponent

public D2WComponent()

Standard Java no-argument constructor.
Static Constants


currentObjectKey
java.lang.String

This constant is intentionally undocumented.
Methods


allEntities

public String allEntities()

This method is intentionally undocumented. You should never have to invoke or customize it.


allowCollapsing

public Integer allowCollapsing()

This method is intentionally undocumented. You should never have to invoke or customize it.


applicationPort

public int applicationPort()

This method is intentionally undocumented. You should never have to invoke or customize it.


assistantPort

protected int assistantPort()

This method is intentionally undocumented. You should never have to invoke or customize it.


attribute

public EOAttribute attribute()

This method is intentionally undocumented. You should never have to invoke or customize it.


backgroundColorForHeaderRow

public String backgroundColorForHeaderRow()

Returns the background color for the header rows of tables rendered by Direct to Web.


backgroundColorForPage

public String backgroundColorForPage()

This method is intentionally undocumented. You should never have to invoke or customize it.


backgroundColorForTable

public String backgroundColorForTable()

Returns the background color for tables rendered in this component. This key is resolved using the rule system.


backgroundColorForTableDark

public String backgroundColorForTableDark()

This method is intentionally undocumented. You should never have to invoke or customize it.


backgroundColorForTableLight

public String backgroundColorForTableLight()

This method is intentionally undocumented. You should never have to invoke or customize it.


color

public String color()

This method is intentionally undocumented. You should never have to invoke or customize it.


currentSettings

public String currentSettings()

This method is intentionally undocumented. You should never have to invoke or customize it.


d2wContext

public D2WContext d2wContext()

Returns the receiver's Direct to Web context (a D2WContext object).


d2wContextVisibleEntityNamesCountPlus1

public String d2wContextVisibleEntityNamesCountPlus1()

Returns a String containing the number of visible entities in the receiver's Direct to Web context incremented by one.


defaultRowspan

public String defaultRowspan()

Returns the number of HTML table rows spanned by the vertical rule in the page containing the Direct to Web context in which the receiver's rule fires. The query and inspect pages in the WebObjects look use this method.


displayNameForKeyWhenRelationship

public String displayNameForKeyWhenRelationship()

Returns a String containing the name of a property that represents the destination object of the current relationship in the receiver's Direct to Web context. Returns null if the current property in the component's Direct to Web context is not a relationship.

The name is derived from the key for one of the properties of the destination entity that can be used to represent that entity. For example, the representative key for Studio could be name. This method determines the key using the rule system. To convert the key to a user-presentable name, the method capitalizes lower case words and inserts spaces between words with mixed case (for example, "firstName" becomes "First Name").


displayNameForProperty

public String displayNameForProperty()

Returns a String containing a user-presentable name for the current property in the component's Direct to Web context. The method derives the name from the property's key by capitalizing lower case words and inserting spaces between words with mixed case (for example, "firstName" becomes "First Name").


displayPropertyKeys

public NSArray displayPropertyKeys()

Returns an NSArray containing the keys (Strings) for all visible properties of the current entity in the components Direct to Web context. The method determines the result using the rule system.

You can hide a property or make it visible with the Web Assistant.


dynamicPages

protected String dynamicPages()

This method is intentionally undocumented. You should never have to invoke or customize it.


entity

public EOEntity entity()

Returns the current entity (an EOEntity object) in the receiver's Direct to Web context. The EOEntity class is defined in the EOAccess Framework.


entityName

public String entityName()

Returns a String containing the name of the entity displayed by this component.


finalize

public void finalize()

This method is intentionally undocumented. You should never have to invoke or customize it.


formatter

public String formatter()

This method is intentionally undocumented. You should never have to invoke or customize it.


generationReplacementFor

protected String generationReplacementFor(String aString)

This method is intentionally undocumented. You should never have to invoke or customize it.


hasCustomKey

public boolean hasCustomKey(String aString)

This method is intentionally undocumented. You should never have to invoke or customize it.


hasEntity

public boolean hasEntity()

Returns whether the receiver's Direct to Web context has an entity or not.


hasNoColor

public boolean hasNoColor()

This method is intentionally undocumented. You should never have to invoke or customize it.


homeClicked

public WOComponent homeClicked()

This method is intentionally undocumented. You should never have to invoke or customize it.


homeHref

public String homeHref()

Returns a String containing the URL of the application's home page (the Main component).


isEditing

public boolean isEditing()

This method is intentionally undocumented. You should never have to invoke or customize it.


isEntityReadOnly

public boolean isEntityReadOnly()

Returns whether the current entity in the receiver's Direct to Web context can be modified or not. You can specify if an entity can be modified using the Web Assistant.


isEntityReadOnly

public boolean isEntityReadOnly(EOEntity anEntity)

This method is intentionally undocumented. You should never have to invoke or customize it.


isLiveAssistantEnabled

public boolean isLiveAssistantEnabled()

This method is intentionally undocumented. You should never have to invoke or customize it.


isNotBoldAsBoolean

public boolean isNotBoldAsBoolean()

This method is intentionally undocumented. You should never have to invoke or customize it.


isNotItalicAsBoolean

public boolean isNotItalicAsBoolean()

This method is intentionally undocumented. You should never have to invoke or customize it.


isPropertyAnAttribute

public boolean isPropertyAnAttribute()

Returns true if the property in the receiver's Direct to Web context is an attribute (and not a relationship).


isWebAssistantActive

public boolean isWebAssistantActive()

This method is intentionally undocumented. You should never have to invoke or customize it.


isWebAssistantConnected

public boolean isWebAssistantConnected()

This method is intentionally undocumented. You should never have to invoke or customize it.


isWebAssistantEnabled

public boolean isWebAssistantEnabled()

This method is intentionally undocumented. You should never have to invoke or customize it.


keyForGenerationReplacementForVariableNamed

public static String keyForGenerationReplacementForVariableNamed(String aString)

This method is intentionally undocumented. You should never have to invoke or customize it.


keyWhenRelationship

public String keyWhenRelationship()

Returns a String containing the key for the property that represents the destination object of the current relationship in the receiver's Direct to Web context. Returns null if the current property in the Direct to Web is not a relationship.

The returned key is the key for one of the properties of the destination entity that can be used to represent the entity. For example, the representative key for Studio could be name. The method determines the result using the rule system.


length

public String length()

This method is intentionally undocumented. You should never have to invoke or customize it.


localContext

public D2WContext localContext()

This method is deprecated. Use d2wContext instead.


logout

public WOComponent logout()

This action method is invoked when the user clicks Logout in the menu bar. It terminates the current session and returns the application's home page WOComponent (Main).


object

public EOEnterpriseObject object()

Returns the EOEnterpriseObject (defined in the EOControl Framework) displayed by this component.


objectPropertyValue

public Object objectPropertyValue()

Returns the value of the current property for the object the receiver displays. For example, if the current entity in the component's Direct to Web context is "Movie" and the current property key is "title", this method returns the title of the movie displayed in this component.


objectPropertyValueIsNonNull

public boolean objectPropertyValueIsNonNull()

This method is intentionally undocumented. You should never have to invoke or customize it.


pageTitle

public String pageTitle()

This method is intentionally undocumented. You should never have to invoke or customize it.


property

public Object property()

This method is intentionally undocumented. You should never have to invoke or customize it.


propertyKey

public String propertyKey()

Returns the key corresponding to the current property in the receiver's Direct to Web context.


propertyValueClassName

public String propertyValueClassName()

Returns a String containing the name of the class for the current attribute's values ("NSString" for example). If the current property in the component's Direct to Web context is not an attribute, this method returns null.


relationship

public EORelationship relationship()

Returns the EORelationship (defined in the EOAccess Framework) for the current property in the receiver's Direct to Web context, or null if the property is not a relationship.


replacementAssociationForAssociation

public WOAssociation replacementAssociationForAssociation(WOAssociation oldAssociation, String oldBinding, DTWTemplate aTemplate, WOContext aContext)

This method is intentionally undocumented. You should never have to invoke or customize it.


resourcePathURL

public String resourcePathURL()

This method is intentionally undocumented. You should never have to invoke or customize it.


sessionID

protected String sessionID()

This method is intentionally undocumented. You should never have to invoke or customize it.


setCurrentSettings

public void setCurrentSettings(String settings)

This method is intentionally undocumented. You should never have to invoke or customize it.


setDynamicPages

protected void setDynamicPages(String aString)

This method is intentionally undocumented. You should never have to invoke or customize it.


setEntities

public void setEntities(String aString)

This method is intentionally undocumented. You should never have to invoke or customize it.


setEntity

public void setEntity(EOEntity entity)

This method is intentionally undocumented. You should never have to invoke or customize it.


setEntityName

public void setEntityName(String aString)

This method is intentionally undocumented. You should never have to invoke or customize it.


setLocalContext

public void setLocalContext(D2WContext context)

Sets the Direct to Web context for this component to context.


setObject

public void setObject(EOEnterpriseObject object)

Sets the EOEnterpriseObject (defined in the EOControl Framework) the receiver manipulates to object.


setPropertyKey

public void setPropertyKey(String aString)

This method is intentionally undocumented. You should never have to invoke or customize it.


setResourcePathURL

public void setResourcePathURL(String aString)

This method is intentionally undocumented. You should never have to invoke or customize it.


setTask

protected void setTask(String aString)

This method is intentionally undocumented. You should never have to invoke or customize it.


setTasks

protected void setTasks(String aString)

This method is intentionally undocumented. You should never have to invoke or customize it.


showBanner

public boolean showBanner()

Returns whether the banner should be shown in this component or not. If the component is an embedded component, the banner is not shown.


showWebAssistant

public WOComponent showWebAssistant()

This action method is invoked when the user clicks Customize in the menu bar. It displays the Web Assistant in the user's browser.


submitActionName

public String submitActionName()

The name of an action method that is called when the user clicks a submit button within the form. This action method is used in the tab panel components, that is, NEUTabInspectPage and WOLTabInspectPage to specify the WOTabPanel's submitActionName binding.


target

public String target()

This method is intentionally undocumented. You should never have to invoke or customize it.


task

protected String task()

Returns a String containing the current task in the receiver's Direct to Web context.


tasks

protected String tasks()

This method is intentionally undocumented. You should never have to invoke or customize it.


visibleEntityNames

public NSArray visibleEntityNames()

Returns an NSArray containing the entities that are visible within the application. You can choose which entities are visible using the Web Assistant.

© 2001 Apple Computer, Inc.