|
| |
|
| java.lang.Object
 org.wings.SComponent
org.wings.SContainer
org.wings.SRootContainer
org.wings.SFrame
All known Subclasses: org.wings.CmsFrame,
| SFrame | | public class SFrame extends SRootContainer implements PropertyChangeListener,LowLevelEventListener(Code) | | The root component of every component hierarchy.
A SessionServlet requires an instance of SFrame to render the page.
SFrame consists of some header informaton (meta, link, script)
and a stack of components. The bottommost component of the stack is always
the contentPane. When dialogs are to be shown, they are stacked on top of
it.
author:
Holger Engels,
author:
Armin Haaf |
| headers | | protected List headers(Code) | | A list of all header used by this frame.
|
| styleSheet | | protected StyleSheet styleSheet(Code) | | the style sheet used in certain look and feels.
|
| SFrame | | public SFrame()(Code) | | Creates a new SFrame
|
| SFrame | | public SFrame(String title)(Code) | | Creates a new SFrame
Parameters:
title - Title of this frame, rendered in browser window title |
| deregisterGlobalInputMapComponent | | public void deregisterGlobalInputMapComponent(SComponent comp)(Code) | | |
| fireIntermediateEvents | | public void fireIntermediateEvents()(Code) | | |
| getDynamicResource | | public DynamicResource getDynamicResource(Class c)(Code) | | Severeral Dynamic code Ressources are attached to a SFrame.
See Frame.plaf for details, but in general you wil find attached
to every SFrame a
- A
ReloadResource rendering the HTML-Code of all SComponents inside this frame.
|
| getDynamicResources | | public Collection getDynamicResources()(Code) | | all dynamic script resources |
| getParentFrame | | public SFrame getParentFrame()(Code) | | Return this.
this. |
| getRequestURL | | final public RequestURL getRequestURL()(Code) | | Returns the base URL for a request to the WingsServlet. This URL
is used to assemble an URL that trigger events. In order to be used
for this purpose, you've to add your parameters here.
|
| getTargetResource | | public String getTargetResource()(Code) | | Every externalized ressource has an id. A frame is a ReloadResource.
The id of this ReloadResource |
| getTitle | | public String getTitle()(Code) | | Title of this HTML page. Typically shown in the browsers window title.
the current page title or an empty string if this page doesn't have a title. |
| handleError | | public boolean handleError(Throwable e)(Code) | | custom error handling. If you want to catch application errors,
return true here.
Parameters:
e - The throwable causing this. does this frame handle errors... |
| initializeContentPane | | protected void initializeContentPane()(Code) | | |
| invalidate | | final public void invalidate()(Code) | | Invalidate this frame by incrementing its event epoch. This method is called
whenever a change took place inside this frame - that is whenever one of its
child components has become dirty. In consequence each dynamic resource which
is attached to this frame has to be externalized with a new "version-number".
|
| isDebugJs | | public boolean isDebugJs()(Code) | | |
| isFormContentPane | | public boolean isFormContentPane()(Code) | | Tell wether the contentPane is an SForm.
true if the contentPane is an SForm, false otherwise |
| isNoCaching | | public boolean isNoCaching()(Code) | | true if the generated HTML code of this frame/page shouldnot be cached by browser, false if no according HTTP/HTML headersshould be rendered
See Also: SFrame.setNoCaching(boolean) |
| isUpdateEnabled | | public boolean isUpdateEnabled()(Code) | | |
| registerGlobalInputMapComponent | | public void registerGlobalInputMapComponent(SComponent comp)(Code) | | |
| removeDynamicResource | | public void removeDynamicResource(Class dynamicResourceClass)(Code) | | Removes the instance of the dynamic ressource of the given class.
Parameters:
dynamicResourceClass - Class of dynamic ressource to remove
See Also: SFrame.getDynamicResource(Class) |
| setBackButton | | public void setBackButton(SButton defaultBackButton)(Code) | | This button allows you to programattically react on Back buttons pressed in the browser itselfs.
This is a convenience method in contrast to
SFrame.addInvalidLowLevelEventListener(SInvalidLowLevelEventListener) .
While the listener throws an event on every detected component receiving an invalid
request, this button is only activated if
- Maximum once per request
- Only if some time passed by to avoid double-clicks to be recognized as back button clicks.
Note: To work correctly you should set use GET posting
SForm.setPostMethod(boolean) and use
SFrame.setNoCaching(boolean) for
no caching. This will advise the browser to reload every back page.
Parameters:
defaultBackButton - A button to trigger upon detected invalid epochs. |
| setFocus | | public void setFocus(SComponent focusOnComponent)(Code) | | Choose which component rendered inside this frame should gain the edit focus on next rendering
This function is called by
SComponent.requestFocus
Parameters:
focusOnComponent - the component which requests the focus. |
| setFormContentPane | | public void setFormContentPane(boolean contentPaneForm)(Code) | | Determine wether the contentPane shall be an SForm. The property is true by default.
Parameters:
contentPaneForm - true if the contentPane shall be an SForm, false otherwise |
| setInputMap | | public void setInputMap(int condition, InputMap inputMap)(Code) | | |
| setRequestURL | | final public void setRequestURL(RequestURL requestURL)(Code) | | Set server address.
|
| setTargetResource | | public void setTargetResource(String targetResource)(Code) | | Set the target resource
|
| setTitle | | public void setTitle(String title)(Code) | | Sets the title of this HTML page. Typically shown in the browsers window title.
Parameters:
title - The window title. |
| setUpdateEnabled | | public void setUpdateEnabled(boolean enabled)(Code) | | |
| Methods inherited from org.wings.SContainer | public SComponent add(SComponent c)(Code)(Java Doc)
public void add(SComponent c, Object constraint)(Code)(Java Doc)
public SComponent add(SComponent c, int index)(Code)(Java Doc)
public void add(SComponent c, Object constraint, int index)(Code)(Java Doc)
public SComponent addComponent(SComponent c)(Code)(Java Doc)
public SComponent addComponent(SComponent c, Object constraint)(Code)(Java Doc)
public SComponent addComponent(SComponent c, int index)(Code)(Java Doc)
public SComponent addComponent(SComponent c, Object constraint, int index)(Code)(Java Doc)
public void addContainerListener(SContainerListener l)(Code)(Java Doc)
public void addNotify()(Code)(Java Doc)
public Object clone()(Code)(Java Doc)
protected void fireContainerEvent(int type, SComponent comp)(Code)(Java Doc)
public SComponent getComponent(int i)(Code)(Java Doc)
public int getComponentCount()(Code)(Java Doc)
protected ArrayList getComponentList()(Code)(Java Doc)
public SComponent[] getComponents()(Code)(Java Doc)
public Object getConstraintAt(int i)(Code)(Java Doc)
protected ArrayList getConstraintList()(Code)(Java Doc)
public SLayoutManager getLayout()(Code)(Java Doc)
public void invite(ComponentVisitor visitor) throws Exception(Code)(Java Doc)
public void inviteEachComponent(ComponentVisitor visitor) throws Exception(Code)(Java Doc)
protected boolean isShowingChildren()(Code)(Java Doc)
protected void processContainerEvent(SContainerListener listener, SContainerEvent e)(Code)(Java Doc)
public void remove(SComponent c)(Code)(Java Doc)
public void remove(int index)(Code)(Java Doc)
public void removeAll()(Code)(Java Doc)
public void removeContainerListener(SContainerListener l)(Code)(Java Doc)
public void removeNotify()(Code)(Java Doc)
public void setCG(ContainerCG cg)(Code)(Java Doc)
public void setLayout(SLayoutManager l)(Code)(Java Doc)
protected void setParentFrame(SFrame f)(Code)(Java Doc)
public void updateCG()(Code)(Java Doc)
|
| Methods inherited from org.wings.SComponent | final public void addComponentListener(SComponentListener l)(Code)(Java Doc)
public void addDynamicStyle(Style style)(Code)(Java Doc)
final protected void addEventListener(Class<T> type, T listener)(Code)(Java Doc)
public void addNotify()(Code)(Java Doc)
final public void addParentFrameListener(SParentFrameListener l)(Code)(Java Doc)
final public void addRenderListener(SRenderListener renderListener)(Code)(Java Doc)
final public void addScriptListener(ScriptListener listener)(Code)(Java Doc)
public void addStyle(String additionalCssClassName)(Code)(Java Doc)
public Object clone()(Code)(Java Doc)
protected void fireComponentChangeEvent(SComponentEvent aEvent)(Code)(Java Doc)
public void fireFinalEvents()(Code)(Java Doc)
protected void fireKeyEvents()(Code)(Java Doc)
final public void fireRenderEvent(int type)(Code)(Java Doc)
public ActionMap getActionMap()(Code)(Java Doc)
public Color getBackground()(Code)(Java Doc)
public SBorder getBorder()(Code)(Java Doc)
public ComponentCG getCG()(Code)(Java Doc)
final public Object getClientProperty(Object key)(Code)(Java Doc)
public SPopupMenu getComponentPopupMenu()(Code)(Java Doc)
public Style getDynamicStyle(Selector selector)(Code)(Java Doc)
public Collection getDynamicStyles()(Code)(Java Doc)
public int getFocusTraversalIndex()(Code)(Java Doc)
public SFont getFont()(Code)(Java Doc)
public Color getForeground()(Code)(Java Doc)
public int getHorizontalAlignment()(Code)(Java Doc)
public InputMap getInputMap()(Code)(Java Doc)
public InputMap getInputMap(int condition)(Code)(Java Doc)
final protected int getListenerCount(Class type)(Code)(Java Doc)
final protected Object[] getListenerList()(Code)(Java Doc)
final public EventListener[] getListeners(Class<? extends EventListener> type)(Code)(Java Doc)
public String getLowLevelEventId()(Code)(Java Doc)
final public String getName()(Code)(Java Doc)
final public SContainer getParent()(Code)(Java Doc)
public SFrame getParentFrame()(Code)(Java Doc)
public SDimension getPreferredSize()(Code)(Java Doc)
public RequestURL getRequestURL()(Code)(Java Doc)
public boolean getResidesInForm()(Code)(Java Doc)
public List<ScriptListener> getScriptListenerList()(Code)(Java Doc)
public ScriptListener[] getScriptListeners()(Code)(Java Doc)
final public Session getSession()(Code)(Java Doc)
public boolean getShowAsFormComponent()(Code)(Java Doc)
public String getStyle()(Code)(Java Doc)
public String getToolTipText()(Code)(Java Doc)
public int getVerticalAlignment()(Code)(Java Doc)
public void invite(ComponentVisitor visitor) throws Exception(Code)(Java Doc)
protected static boolean isDifferent(Object oldObject, Object newObject)(Code)(Java Doc)
public boolean isEnabled()(Code)(Java Doc)
public boolean isFocusOwner()(Code)(Java Doc)
public boolean isRecursivelyVisible()(Code)(Java Doc)
public boolean isReloadForced()(Code)(Java Doc)
protected boolean isUpdatePossible()(Code)(Java Doc)
public boolean isVisible()(Code)(Java Doc)
protected String paramString()(Code)(Java Doc)
protected void processComponentEvent(SComponentListener listener, SComponentEvent e)(Code)(Java Doc)
protected boolean processKeyEvents(String[] values)(Code)(Java Doc)
protected void processLowLevelEvent(String name, String[] values)(Code)(Java Doc)
final public void putClientProperty(Object key, Object value)(Code)(Java Doc)
final void register()(Code)(Java Doc)
public void reload()(Code)(Java Doc)
final protected void reloadIfChange(Object oldVal, Object newVal)(Code)(Java Doc)
final protected void reloadIfChange(int oldVal, int newVal)(Code)(Java Doc)
final protected void reloadIfChange(boolean oldVal, boolean newVal)(Code)(Java Doc)
final protected void reloadIfChange(byte oldVal, byte newVal)(Code)(Java Doc)
final protected void reloadIfChange(short oldVal, short newVal)(Code)(Java Doc)
final protected void reloadIfChange(long oldVal, long newVal)(Code)(Java Doc)
final protected void reloadIfChange(float oldVal, float newVal)(Code)(Java Doc)
final protected void reloadIfChange(double oldVal, double newVal)(Code)(Java Doc)
final protected void reloadIfChange(char oldVal, char newVal)(Code)(Java Doc)
final public void removeComponentListener(SComponentListener l)(Code)(Java Doc)
public void removeDynamicStyle(Selector selector)(Code)(Java Doc)
final protected void removeEventListener(Class<T> type, T listener)(Code)(Java Doc)
public void removeNotify()(Code)(Java Doc)
final public void removeParentFrameListener(SParentFrameListener l)(Code)(Java Doc)
final public void removeRenderListener(SRenderListener renderListener)(Code)(Java Doc)
final public void removeScriptListener(ScriptListener listener)(Code)(Java Doc)
public void removeStyle(String cssStyleClassName)(Code)(Java Doc)
public void requestFocus()(Code)(Java Doc)
public void scrollRectToVisible(Rectangle aRect)(Code)(Java Doc)
public void setActionMap(ActionMap actionMap)(Code)(Java Doc)
public void setAttribute(String cssPropertyName, String value)(Code)(Java Doc)
public void setAttribute(CSSProperty property, String propertyValue)(Code)(Java Doc)
public void setAttribute(Selector selector, CSSProperty property, String propertyValue)(Code)(Java Doc)
public void setAttribute(Selector selector, CSSProperty property, SIcon icon)(Code)(Java Doc)
public void setAttribute(Selector selector, CSSProperty property, Color color)(Code)(Java Doc)
public void setAttributes(Selector selector, CSSAttributeSet attributes)(Code)(Java Doc)
public void setBackground(Color color)(Code)(Java Doc)
public void setBorder(SBorder border)(Code)(Java Doc)
public void setCG(ComponentCG newCG)(Code)(Java Doc)
public void setComponentPopupMenu(SPopupMenu popupMenu)(Code)(Java Doc)
public void setDynamicStyles(Collection dynamicStyles)(Code)(Java Doc)
public void setEnabled(boolean enabled)(Code)(Java Doc)
public void setFocusTraversalIndex(int index)(Code)(Java Doc)
public void setFont(SFont font)(Code)(Java Doc)
public void setForeground(Color color)(Code)(Java Doc)
public void setHorizontalAlignment(int alignment)(Code)(Java Doc)
public void setInputMap(InputMap inputMap)(Code)(Java Doc)
public void setInputMap(int condition, InputMap inputMap)(Code)(Java Doc)
public void setName(String uniqueName)(Code)(Java Doc)
public void setNameRaw(String uncheckedName)(Code)(Java Doc)
public void setParent(SContainer parent)(Code)(Java Doc)
protected void setParentFrame(SFrame parentFrame)(Code)(Java Doc)
public void setPreferredSize(SDimension preferredSize)(Code)(Java Doc)
public void setReloadForced(boolean forced)(Code)(Java Doc)
public void setShowAsFormComponent(boolean showAsFormComponent)(Code)(Java Doc)
public void setStyle(String cssClassName)(Code)(Java Doc)
public void setToolTipText(String t)(Code)(Java Doc)
public void setVerticalAlignment(int alignment)(Code)(Java Doc)
public void setVisible(boolean visible)(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final void unregister()(Code)(Java Doc)
public void update(Update update)(Code)(Java Doc)
public void updateCG()(Code)(Java Doc)
public void write(Device s) throws IOException(Code)(Java Doc)
|
|
|
|