|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface PageSupport
Some common page methods
Copyright (c) Xoetrope Ltd., 2002-2005
License: see license.txt
$Revision: 1.9 $Method Summary | |
---|---|
int |
accumulateMessages(boolean start, int level) Informs the handler when a page validation is starting or stopping. |
void |
addActionHandler(java.lang.Object comp, java.lang.String methodName) Adds a handler for action events |
void |
addBinding(XDataBinding b) Add a binding of a component to the data model. |
void |
addFocusHandler(java.lang.Object comp, java.lang.String methodName) Adds a handler for focus events |
void |
addHandler(java.lang.Object comp, long eventType, java.lang.String methodName) Adds an event handler. |
void |
addHandler(java.lang.Object srcObj, java.lang.String methodName, java.lang.String adderMethod, java.lang.String listenerInterface, long eventMask, java.lang.Object listener) Adds a handler for action events |
void |
addItemHandler(java.lang.Object comp, java.lang.String methodName) Adds a handler for item events |
void |
addKeyHandler(java.lang.Object comp, java.lang.String methodName) Adds a handler for key events |
void |
addListener(java.lang.Object comp, java.lang.String listenerName, java.lang.String argType, java.lang.Object listener) Adds a listener for an event type. |
void |
addMenuHandler(java.lang.Object menuItem, java.lang.String methodName) Adds a handler for action events |
void |
addMouseHandler(java.lang.Object comp, java.lang.String methodName) Adds a handler for mouse events |
void |
addMouseMotionHandler(java.lang.Object comp, java.lang.String methodName) Adds a handler for mouse motion events |
void |
addTextHandler(java.lang.Object comp, java.lang.String methodName) Adds a handler for text events |
XValidator |
addValidation(java.lang.Object comp, java.lang.String validationName) Adds a validation to this page. |
XValidator |
addValidation(java.lang.Object comp, java.lang.String validationName, java.lang.String method) Adds a validation to this page. |
XValidator |
addValidation(java.lang.Object comp, java.lang.String validationName, java.lang.String method, int mask, XmlElement pageEle) Adds a validation to this page. |
int |
checkValidations() Check all validations for this page. |
void |
clearValidations() Reset/removes all validations |
void |
doLayout() Layout the page |
java.lang.Object |
evaluateAttribute(java.lang.String attribValue) Evaluates an attribute value. |
java.lang.String |
evaluatePath(java.lang.String path) Evaluates a path (potentially) containing a method call |
java.lang.Object |
findComponent(java.lang.Object container, java.lang.String name) Find a named component in the container. |
java.lang.Object |
findComponent(java.lang.String name) Find a named component in the container. |
java.lang.Object |
getAttribute(java.lang.String attribName) Gets an attribute value |
java.lang.Object |
getAttribute(java.lang.String attribName, java.lang.String compName) Gets an attribute value |
XDataBinding |
getBinding(java.lang.Object targetComp) Find the data binding associated with a component |
XDataBinding |
getBinding(java.lang.String targetPath) Find the data binding associated with a data source path |
java.util.Vector |
getBindings() Get the data bindings for the page |
XComponentFactory |
getComponentFactory() Get the component factory instance being used by this page. |
java.lang.String |
getComponentName(java.lang.Object comp) Get a name for a component. |
java.util.EventObject |
getCurrentEvent() Get the current event |
java.lang.Object |
getEventAttribute(java.lang.Object c, java.lang.String attribName) Gets an attribute value belonging to a component |
XuiEventHandler |
getEventHandler() Get the current event handler |
java.lang.String |
getName() Get the name of the page |
java.lang.Object |
getOwner() Get the parent |
java.awt.Dimension |
getPageSize() Get the size |
int |
getStatus() Get the page status |
XValidationHandler |
getValidationHandler() Gets the validation handler |
boolean |
handleEventHandlerException(XProject project, java.lang.Object container, java.lang.Throwable error) Handle an exception during the invocation of a page's event handler. |
boolean |
handleException(java.lang.Object comp, java.lang.Exception ex, java.lang.Object validator) A method called when a validation exeption has been trapped. |
boolean |
isFocusChangeSuppressed() Check the focus change status |
void |
pageActivated() A method called once the page has been created and initialized but just prior to display |
void |
pageCreated() A method called once the page has been created but not yet initialized. |
void |
pageDeactivated() Called when the page is about to loose scope and be hidden. |
void |
removeBinding(XDataBinding b) Remove a binding of a component to the data model. |
void |
saveBoundComponentValues() Save the component values to the model |
void |
setAttribute(java.lang.String attribName, java.lang.String compName, java.lang.Object attribValue) Set a named attributes. |
void |
setBackground(java.awt.Color c) Set the background color |
void |
setClearPage(boolean value) Modify the clearPage flag. |
void |
setComponentFactory(XStyleFactory factory) Set the component factory instance being used by this page when constructing new pages. |
void |
setEventHandler(XuiEventHandler eh) Set the current event handler |
void |
setExceptionHandler(XExceptionHandler eh) Set the validation exception handler called when a validation exception is trapped |
void |
setLayout(java.lang.Object obj) Set the layout manager |
void |
setLocation(int x, int y) Set the page location |
void |
setName(java.lang.String name) Set the name of the component |
void |
setSize(int width, int height) Set the page size |
void |
setStatus(int newStatus) Set the page status |
void |
setValidationFactory(java.lang.String vf) Sets the factory used to create XValidator objects. |
void |
setValidationFactory(XValidationFactory vf) Sets the factory used to create XValidator objects |
void |
setVisible(boolean state) Set the visible state of the component |
void |
showComponents(java.lang.Object container, boolean visible, int recursionLevel) Show or hide the components. |
void |
showHandCursor(java.lang.Object comp) Show the hand/pointer cursor for this component |
void |
showMessage(java.lang.Object parent, java.lang.String title, java.lang.String msg) Shows a modal message box |
void |
showMessage(java.lang.String title, java.lang.String msg) Shows a modal message box |
java.lang.String |
stripAttributeValues(java.lang.String path) Remove the attribute paths from a path e.g. |
java.lang.String |
translate(java.lang.String key) Get the translatation refernced by the key |
void |
updateBinding(XDataBinding binding) Update the bound model node for the binding. |
void |
updateBindings() Iterate all of the bindings in the page to reflect the model state. |
void |
updateBoundComponentValues() Update the UI with values from the model |
void |
validate() Validates this container and all of its subcomponents. |
int |
validationHandler() Invoke the validators for the last event. |
boolean |
wasMouseClicked() A utility method used to determine if the last event corrseponds to a mouse click. |
boolean |
wasMouseDoubleClicked() A utility method used to determine if the last event corrseponds to a mouse double click. |
boolean |
wasMouseRightClicked() A utility method used to determine if the last event corrseponds to a mouse right click. |
Method Detail |
---|
void setBackground(java.awt.Color c)
c
- The colorvoid setLayout(java.lang.Object obj)
obj
- the layout manager instancevoid doLayout()
java.lang.String getName()
void setVisible(boolean state)
state
- true to make the component visiblevoid setClearPage(boolean value)
value
- the new flag value, true to clearvoid showComponents(java.lang.Object container, boolean visible, int recursionLevel)
recursionLevel
- a counter of the recursion levelcontainer
- the containervisible
- true to show the componentsjava.lang.Object findComponent(java.lang.String name)
name
- the name to locatejava.lang.Object findComponent(java.lang.Object container, java.lang.String name)
container
- the page or container to searchname
- the name to locatevoid setName(java.lang.String name)
name
- the new name for the pagevoid setExceptionHandler(XExceptionHandler eh)
eh
- the new event handlerboolean handleException(java.lang.Object comp, java.lang.Exception ex, java.lang.Object validator)
handleException
in interface XExceptionHandler
comp
- Component being validatedex
- The exception causedvalidator
- The validator being used to validate.boolean handleEventHandlerException(XProject project, java.lang.Object container, java.lang.Throwable error)
handleEventHandlerException
in interface XExceptionHandler
project
- the current projectcontainer
- the pageerror
- the exception or error that was thrownvoid clearValidations()
int checkValidations()
int accumulateMessages(boolean start, int level)
accumulateMessages
in interface XExceptionHandler
start
- boolean to indicate whether the accumulation is started or stopped.level
- int which indicates the most serious level of error encounteredXValidator addValidation(java.lang.Object comp, java.lang.String validationName, java.lang.String method, int mask, XmlElement pageEle)
comp
- the component being validatedvalidationName
- the name of the validation in the validation filemethod
- the method used to get the component's value if anymask
- the event mask used to filter the events that trigger the validationpageEle
- the XML element which is declared in the pageXValidator addValidation(java.lang.Object comp, java.lang.String validationName, java.lang.String method)
comp
- the component being validatedvalidationName
- the name of the validation in the validation filemethod
- the method used to get the component's value if anyXValidator addValidation(java.lang.Object comp, java.lang.String validationName)
comp
- the component being validatedvalidationName
- the name of the validation in the validation filevoid setValidationFactory(XValidationFactory vf)
vf
- The validation factoryvoid setValidationFactory(java.lang.String vf)
vf
- the filenameXValidationHandler getValidationHandler()
int validationHandler()
XuiEventHandler getEventHandler()
void setEventHandler(XuiEventHandler eh)
eh
- The event handlerjava.util.EventObject getCurrentEvent()
void addListener(java.lang.Object comp, java.lang.String listenerName, java.lang.String argType, java.lang.Object listener)
comp
- the component that fires eventslistenerName
- the name of the listener interfaceargType
- the listener argumentslistener
- the listener implementationvoid addHandler(java.lang.Object comp, long eventType, java.lang.String methodName) throws java.lang.Exception
comp
- the component that fires the eventeventType
- the event ID/maskmethodName
- the method to be invoked in response to the objectjava.lang.Exception
- couldn't find or add the event handlervoid addHandler(java.lang.Object srcObj, java.lang.String methodName, java.lang.String adderMethod, java.lang.String listenerInterface, long eventMask, java.lang.Object listener)
srcObj
- the menu item that fires the eventsmethodName
- the method to be invoked in response to the action eventadderMethod
- the adder method name e.g. addActionListenerlistenerInterface
- the listener interface e.g. java.awt.event.ActionListenereventMask
- the event mask e.g. AWTEvent.ACTION_EVENT_MASKlistener
- the listener implementation, usually the page's this pointerActionListener
, ActionEvent
boolean isFocusChangeSuppressed()
void addMenuHandler(java.lang.Object menuItem, java.lang.String methodName)
menuItem
- the component that fires the eventmethodName
- the method to be invoked in response to the action eventActionListener
, ActionEvent
void addActionHandler(java.lang.Object comp, java.lang.String methodName)
comp
- the component that fires the eventsmethodName
- the method to be invoked in response to the action eventActionListener
, ActionEvent
void addFocusHandler(java.lang.Object comp, java.lang.String methodName)
comp
- the component that fires the eventsmethodName
- the method to be invoked in response to the focus eventFocusListener
, FocusEvent
void addTextHandler(java.lang.Object comp, java.lang.String methodName)
comp
- the component that fires the eventsmethodName
- the method to be invoked in response to the text eventTextListener
, TextEvent
void addItemHandler(java.lang.Object comp, java.lang.String methodName)
comp
- the component that fires the eventsmethodName
- the method to be invoked in response to the item eventItemListener
, ItemEvent
void addKeyHandler(java.lang.Object comp, java.lang.String methodName)
comp
- the component that fires the eventsmethodName
- the method to be invoked in response to the key eventKeyListener
, KeyEvent
void addMouseHandler(java.lang.Object comp, java.lang.String methodName)
comp
- the component that fires the eventsmethodName
- the method to be invoked in response to the mouse eventMouseMotionListener
, MouseEvent
void addMouseMotionHandler(java.lang.Object comp, java.lang.String methodName)
comp
- the component that fires the eventsmethodName
- the method to be invoked in response to the mouse eventMouseMotionListener
, MouseEvent
boolean wasMouseClicked()
boolean wasMouseDoubleClicked()
boolean wasMouseRightClicked()
void showHandCursor(java.lang.Object comp)
comp
- the componentjava.util.Vector getBindings()
void addBinding(XDataBinding b)
b
- the bindingvoid removeBinding(XDataBinding b)
b
- the bindingvoid updateBindings()
void updateBinding(XDataBinding binding)
binding
- the data binding to updatevoid updateBoundComponentValues()
void saveBoundComponentValues()
XDataBinding getBinding(java.lang.Object targetComp)
targetComp
- the component whose binding is requiredXDataBinding getBinding(java.lang.String targetPath)
targetPath
- the path to the bound modelint getStatus()
void setStatus(int newStatus)
newStatus
- the new page statusvoid pageActivated()
void pageCreated()
void pageDeactivated()
void setAttribute(java.lang.String attribName, java.lang.String compName, java.lang.Object attribValue)
Set a named attributes. The attributes are stored in a hashtable owned by the page. Derived classes may access the hashtable directly but the preferred method of access is the getAttribute method. Attributes are used by the XuiBuilder class for component attributes other than those it handles directly. The attributes can be thought of as component properties or extra data and need not be used directly by the component.
Attributes are stored using a key in the form attribName_compName or just the attribName if compName is null.
attribName
- the attribute namecompName
- the component name or null if it is a page attributeattribValue
- the attribute valuegetAttribute(java.lang.String)
java.lang.Object getAttribute(java.lang.String attribName)
attribName
- the name of the attributejava.lang.Object getAttribute(java.lang.String attribName, java.lang.String compName)
attribName
- the name of the attributecompName
- the component namejava.lang.String getComponentName(java.lang.Object comp)
comp
- the componentjava.lang.Object getEventAttribute(java.lang.Object c, java.lang.String attribName)
c
- the component/containerattribName
- the name of the attributejava.lang.Object evaluateAttribute(java.lang.String attribValue)
attribValue
- the raw attribute valuejava.lang.String evaluatePath(java.lang.String path)
path
- the raw pathjava.lang.String stripAttributeValues(java.lang.String path)
path
- the path to stripXComponentFactory getComponentFactory()
void setComponentFactory(XStyleFactory factory)
factory
- the component factory used for component creationjava.lang.String translate(java.lang.String key)
key
- the language string lookup keyvoid showMessage(java.lang.String title, java.lang.String msg)
title
- the message dialog titlemsg
- the text of the messagevoid showMessage(java.lang.Object parent, java.lang.String title, java.lang.String msg)
parent
- the message dialog parenttitle
- the message dialog titlemsg
- the text of the messagevoid validate()
java.lang.Object getOwner()
java.awt.Dimension getPageSize()
void setSize(int width, int height)
width
- the new page widthheight
- the new page heightvoid setLocation(int x, int y)
x
- the new page's left edge coordinatey
- the new page's top coordinate
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |