WebObjects 5.2.3

com.webobjects.eogeneration
Class EOWidgetController

java.lang.Object
  extended bycom.webobjects.eoapplication.EOController
      extended bycom.webobjects.eoapplication.EOComponentController
          extended bycom.webobjects.eogeneration.EOWidgetController
All Implemented Interfaces:
EOAction.Enabling, NSDisposable, NSKeyValueCoding, NSKeyValueCoding.ErrorHandling, NSKeyValueCodingAdditions
Direct Known Subclasses:
EOAssociationController, EORangeWidgetController

public abstract class EOWidgetController
extends EOComponentController


Nested Class Summary
static interface EOWidgetController.DefaultAction
           
static interface EOWidgetController.FormatWidget
           
static interface EOWidgetController.QueryWidget
           
static interface EOWidgetController.TableWidget
           
 
Nested classes inherited from class com.webobjects.eoapplication.EOComponentController
EOComponentController.ActionCollector, EOComponentController.Activation, EOComponentController.EndEditing, EOComponentController.Modal, EOComponentController.ResetUserInterface
 
Nested classes inherited from class com.webobjects.eoapplication.EOController
EOController.Enumeration
 
Nested classes inherited from class com.webobjects.foundation.NSKeyValueCoding
NSKeyValueCoding.DefaultImplementation, NSKeyValueCoding.ErrorHandling, NSKeyValueCoding.Null, NSKeyValueCoding.UnknownKeyException, NSKeyValueCoding.Utility, NSKeyValueCoding.ValueAccessor
 
Nested classes inherited from class com.webobjects.foundation.NSKeyValueCodingAdditions
NSKeyValueCodingAdditions.DefaultImplementation, NSKeyValueCodingAdditions.Utility
 
Field Summary
 
Fields inherited from class com.webobjects.eoapplication.EOComponentController
Bottom, BottomLeft, BottomRight, Center, Left, Right, Top, TopLeft, TopRight
 
Fields inherited from class com.webobjects.eoapplication.EOController
ControllerAndSubcontrollersEnumeration, ControllerAndSupercontrollersEnumeration, SubcontrollersEnumeration, SupercontrollersEnumeration
 
Fields inherited from interface com.webobjects.foundation.NSKeyValueCoding
NullValue
 
Fields inherited from interface com.webobjects.foundation.NSKeyValueCodingAdditions
KeyPathSeparator
 
Constructor Summary
EOWidgetController()
           
EOWidgetController(EOXMLUnarchiver unarchiver)
           
 
Method Summary
 void dispose()
          Prepares the receiver so it is disposed when Java performs garbage collection.
protected  void generateComponent()
          Invoked when it's necessary to create the receiver's component, including setting up the subcontroller area.
 boolean highlightsLabel()
           
 JComponent labelComponent()
           
 int labelComponentAlignment()
           
 int labelComponentPosition()
           
 int labelComponentWidth()
          Returns the receiver's alignment width, the minimum width used for text labels in its component (and its integrated subcontroller components).
 Dimension minimumWidgetSize()
           
protected  JComponent newLabelComponent(String label, int minimumWidth, boolean appendColon, int alignment, boolean highlightLabel)
           
protected abstract  JComponent newWidget()
           
protected  int preferredLabelComponentPosition()
           
protected  boolean preferredUsesLabelComponent()
           
protected  int preferredWidgetAutosizingMask()
           
protected  void setAlignmentForWidget(JComponent widget, int alignment)
           
 void setHighlightsLabel(boolean flag)
           
 void setLabelComponent(JComponent labelComponent)
           
 void setLabelComponentAlignment(int alignment)
           
 void setLabelComponentPosition(int position)
           
 void setLabelComponentWidth(int labelComponentWidth)
          Sets the receiver's alignment width, the minimum width used for text labels in its component (and its integrated subcontroller components).
 void setMinimumWidgetSize(Dimension size)
           
 void setUsesLabelComponent(boolean flag)
           
 void setWidget(JComponent widget)
           
 void setWidgetAlignment(int alignment)
           
protected  void startListeningToWidget()
           
protected  void stopListeningToWidget()
           
protected  JComponent toolTipComponent()
          Returns the component that will be used to display tool tip text.
 boolean usesLabelComponent()
           
 JComponent widget()
           
 int widgetAlignment()
           
 
Methods inherited from class com.webobjects.eoapplication.EOComponentController
activateFirstFocusComponent, addComponentOfSubcontroller, alignsComponents, canBeTransient, canResizeHorizontally, canResizeVertically, component, componentDidBecomeInvisible, componentDidBecomeVisible, defaultComponentSize, ensureMinimumComponentSizeWithoutSubcontrollers, ensureMinimumSubcontrollerAreaSize, firstFocusComponent, handleTakeValueForUnboundKey, hideInSupercontroller, hideSubcontroller, icon, insets, integrationComponent, integrationComponentDidBecomeInvisible, integrationComponentDidBecomeVisible, isComponentPrepared, isRootComponentController, isVisible, label, lastFocusComponent, makeInvisible, makeVisible, minimumComponentSize, minimumComponentSizeWithoutSubcontrollers, minimumIntegrationComponentSize, minimumSubcontrollerAreaSize, prefersIconOnly, prepareComponent, removeComponentOfSubcontroller, removeTransientSubcontroller, setAlignsComponents, setCanResizeHorizontally, setCanResizeVertically, setComponent, setDefaultComponentSize, setFirstFocusComponent, setIcon, setInsets, setLabel, setLastFocusComponent, setPrefersIconOnly, setSubcontrollerArea, setToolTip, setUsesHorizontalLayout, setVisible, showInSupercontroller, showSubcontroller, subcontrollerArea, subcontrollerMinimumSizeDidChange, subcontrollerWasAdded, subcontrollerWasRemoved, toolTip, toString, usesHorizontalLayout
 
Methods inherited from class com.webobjects.eoapplication.EOController
actionNames, actions, actionWithName, additionalActions, additionalKeyValuePairs, addSubcontroller, breakConnection, breakConnectionToSubcontrollers, canAccessFieldsDirectly, canPerformActionNamed, connectionWasBroken, connectionWasEstablished, controllerEnumeration, controllersInEnumeration, controllersWithKeyValuePair, controllersWithKeyValuePairs, controllerWithKeyValuePair, controllerWithKeyValuePairs, defaultActions, disableActionNamed, disposableRegistry, disposeIfTransient, enableActionNamed, enabledActions, establishConnection, establishConnectionToSupercontrollers, handleQueryWithUnboundKey, hierarchicalControllerForKey, hierarchicalValueForKey, invokeMethod, isActionNamedEnabled, isAncestorOfController, isConnected, isSupercontrollerOfController, isTransientExplicitlyForbidden, prepareForNewTask, removeFromSupercontroller, removeSubcontroller, resetActions, setAdditionalActions, setAdditionalKeyValuePair, setAdditionalKeyValuePairs, setConnected, setSupercontroller, setTransientExplicitlyForbidden, setTypeName, subcontrollers, supercontroller, supercontroller, takeValueForKey, takeValueForKeyPath, typeName, unableToSetNullForKey, valueForKey, valueForKeyPath
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

EOWidgetController

public EOWidgetController()

EOWidgetController

public EOWidgetController(EOXMLUnarchiver unarchiver)
Method Detail

dispose

public void dispose()
Description copied from class: EOComponentController
Prepares the receiver so it is disposed when Java performs garbage collection.

Specified by:
dispose in interface NSDisposable
Overrides:
dispose in class EOComponentController

generateComponent

protected void generateComponent()
Description copied from class: EOComponentController

Invoked when it's necessary to create the receiver's component, including setting up the subcontroller area. Subclass implementations of this method usually invoke setComponent and if necessary setSubcontrollerArea. EOComponentController's default implementation creates an empty EOView to hold subcontroller components.

The layout mechanisms used to integrate the components of controllers expect that the component is generated with the minimum size possible.

Overrides:
generateComponent in class EOComponentController

highlightsLabel

public boolean highlightsLabel()

labelComponent

public JComponent labelComponent()

labelComponentAlignment

public int labelComponentAlignment()

labelComponentPosition

public int labelComponentPosition()

labelComponentWidth

public int labelComponentWidth()
Returns the receiver's alignment width, the minimum width used for text labels in its component (and its integrated subcontroller components).

Returns:
the alignment width

minimumWidgetSize

public Dimension minimumWidgetSize()

newLabelComponent

protected JComponent newLabelComponent(String label,
                                       int minimumWidth,
                                       boolean appendColon,
                                       int alignment,
                                       boolean highlightLabel)

newWidget

protected abstract JComponent newWidget()

preferredLabelComponentPosition

protected int preferredLabelComponentPosition()

preferredUsesLabelComponent

protected boolean preferredUsesLabelComponent()

preferredWidgetAutosizingMask

protected int preferredWidgetAutosizingMask()

setAlignmentForWidget

protected void setAlignmentForWidget(JComponent widget,
                                     int alignment)

setHighlightsLabel

public void setHighlightsLabel(boolean flag)

setLabelComponent

public void setLabelComponent(JComponent labelComponent)

setLabelComponentAlignment

public void setLabelComponentAlignment(int alignment)

setLabelComponentPosition

public void setLabelComponentPosition(int position)

setLabelComponentWidth

public void setLabelComponentWidth(int labelComponentWidth)
Sets the receiver's alignment width, the minimum width used for text labels in its component (and its integrated subcontroller components). Throws an IllegalStateException if the receiver's component is already prepared. In other words, you can only set the alignment behavior before the component is generated.

Parameters:
labelComponentWidth - the alignment width

setMinimumWidgetSize

public void setMinimumWidgetSize(Dimension size)

setUsesLabelComponent

public void setUsesLabelComponent(boolean flag)

setWidget

public void setWidget(JComponent widget)

setWidgetAlignment

public void setWidgetAlignment(int alignment)

startListeningToWidget

protected void startListeningToWidget()

stopListeningToWidget

protected void stopListeningToWidget()

toolTipComponent

protected JComponent toolTipComponent()
Description copied from class: EOComponentController
Returns the component that will be used to display tool tip text.

Overrides:
toolTipComponent in class EOComponentController
Returns:
JComponent the tool tip component for this controller

usesLabelComponent

public boolean usesLabelComponent()

widget

public JComponent widget()

widgetAlignment

public int widgetAlignment()

Last updated Thu Oct 21 15:04:16 PDT 2004.

Copyright © 2004 Apple Computer, Inc.