Home | Trees | Indices | Help |
|
---|
|
object --+ | util.IEventListener --+ | terminal.paintable.IPaintable --+ | object --+ | | | terminal.variable_owner.IVariableOwner --+ | object --+ | | | terminal.sizeable.ISizeable --+ | IComponent
IComponent
is the top-level interface that is and must be
implemented by all Muntjac components. IComponent
is paired
with AbstractComponent, which provides a default
implementation for all the methods defined in this interface.
Components are laid out in the user interface hierarchically. The
layout is managed by layout components, or more generally by components
that implement the ComponentContainer
interface. Such a container is the parent of the contained
components.
The getParent method allows retrieving the parent component
of a component. While there is a setParent, you rarely need it as you normally add
components with the addComponent()
method of
the layout or other ComponentContainer
, which automatically
sets the parent.
A component becomes attached to an application (and the attach is called) when it or one of its parents is attached to the main window of the application through its containment hierarchy.
Version: 1.1.2
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
Inherited from Inherited from Inherited from Inherited from |
|
|||
Inherited from |
|
|||
Inherited from |
|
Gets all user-defined CSS style names of a component. If the component has multiple style names defined, the return string is a space-separated list of style names. Built-in style names defined in Muntjac or GWT are not returned. The style names are returned only in the basic form in which they were added; each user-defined style name shows as two CSS style class names in the rendered HTML: one as it was given and one prefixed with the component-specific style name. Only the former is returned.
|
Sets one or more user-defined style names of the component, replacing any previous user-defined styles. Multiple styles can be specified as a space-separated list of style names. The style names must be valid CSS class names and should not conflict with any built-in style names in Muntjac or GWT: label = new Label("This text has a lot of style") label.setStyleName("myonestyle myotherstyle") Each style name will occur in two versions: one as specified and one
that is prefixed with the style name of the component. For example, if
you have a .myonestyle {background: blue;} or: .v-button-myonestyle {background: blue;} It is normally a good practice to use addStyleName rather than this setter, as different software abstraction layers can then add their own styles without accidentally removing those defined in other layers. This method will trigger a RepaintRequestEvent.
|
Adds a style name to component. The style name will be rendered as a HTML class name, which can be used in a CSS definition: label = new Label("This text has style") label.addStyleName("mystyle") Each style name will occur in two versions: one as specified and one
that is prefixed wil the style name of the component. For example, if you
have a .mystyle {font-style: italic;} or: .v-button-mystyle {font-style: italic;} This method will trigger a RepaintRequestEvent.
|
Removes one or more style names from component. Multiple styles can be specified as a space-separated list of style names. The parameter must be a valid CSS style name. Only user-defined style names added with addStyleName or setStyleName can be removed; built-in style names defined in Muntjac or GWT can not be removed. This method will trigger a RepaintRequestEvent.
|
Tests whether the component is enabled or not. A user can not interact with disabled components. Disabled components are rendered in a style that indicates the status, usually in gray color. Children of a disabled component are also disabled. Components are enabled by default. As a security feature, all variable change events for disabled components are blocked on the server-side.
See Also: IVariableOwner.isEnabled |
Enables or disables the component. The user can not interact disabled components, which are shown with a style that indicates the status, usually shaded in light gray color. Components are enabled by default. Children of a disabled component are automatically disabled; if a child component is explicitly set as disabled, changes in the disabled status of its parents do not change its status: enabled = new Button("Enabled") enabled.setEnabled(True) # the default layout.addComponent(enabled) disabled = Button("Disabled") disabled.setEnabled(False) layout.addComponent(disabled) This method will trigger a RepaintRequestEvent for the component and, if it is a
|
Tests the visibility property of the component. Visible components are drawn in the user interface, while invisible ones are not. The effect is not merely a cosmetic CSS change, but the entire HTML element will be empty. Making a component invisible through this property can alter the positioning of other components. A component is visible only if all its parents are also visible. Notice that if a child component is explicitly set as invisible, changes in the visibility status of its parents do not change its status. This method does not check whether the component is attached (see attach). The component and all its parents may be
considered "visible", but not necessarily attached to
application. To test if component will actually be drawn, check both its
visibility and that getApplication does not return
|
Sets the visibility of the component. Visible components are drawn in the user interface, while invisible ones are not. The effect is not merely a cosmetic CSS change, but the entire HTML element will be empty: readonly = TextField("Read-Only") readonly.setValue("You can't see this!") readonly.setVisible(False) layout.addComponent(readonly) A component is visible only if all of its parents are also visible. If a component is explicitly set to be invisible, changes in the visibility of its parents will not change the visibility of the component.
See Also: isVisible |
Gets the parent component of the component. Components can be nested but a component can have only one parent. A
component that contains other components, that is, can be a parent,
should usually inherit the
See Also: setParent |
Sets the parent component of the component. This method automatically calls attach if the parent becomes attached to the
application, regardless of whether it was attached previously.
Conversely, if the parent is This method is rarely called directly. The It is not possible to change the parent without first setting the
parent to
|
Tests whether the component is in the read-only mode. The user can not change the value of a read-only component. As only IField components normally have a value that can be input or changed by the user, this is mostly relevant only to field components, though not restricted to them. Notice that the read-only mode only affects whether the user can change the value of the component; it is possible to, for example, scroll a read-only table. The read-only status affects only the user; the value can still be
changed programmatically, for example, with The method will return
See Also: setReadOnly |
Sets the read-only mode of the component to the specified mode. The user can not change the value of a read-only component. As only IField components normally have a value that can be input or changed by the user, this is mostly relevant only to field components, though not restricted to them. Notice that the read-only mode only affects whether the user can change the value of the component; it is possible to, for example, scroll a read-only table. The read-only status affects only the user; the value can still be
changed programmatically, for example, with This method will trigger a RepaintRequestEvent.
|
Gets the caption of the component. See setCaption for a detailed description of the caption.
See Also: setCaption |
Sets the caption of the component. A caption is an explanatory textual label accompanying a user interface component, usually shown above, left of, or inside the component. Icon (see setIcon is closely related to caption and is usually displayed horizontally before or after it, depending on the component and the containing layout. The caption can usually also be given as the first parameter to a constructor, though some components do not support it: area = new RichTextArea() area.setCaption("You can edit stuff here") area.setValue("<h1>Helpful Heading</h1>" + "<p>All this is for you to edit.</p>") The contents of a caption are automatically quoted, so no raw XHTML can be rendered in a caption. The validity of the used character encoding, usually UTF-8, is not checked. The caption of a component is, by default, managed and displayed by the layout component or component container in which the component is placed. For example, the VerticalLayout component shows the captions left-aligned above the contained components, while the FormLayout component shows the captions on the left side of the vertically laid components, with the captions and their associated components left-aligned in their own columns. The CustomComponent does not manage the caption of its composition root, so if the root component has a caption, it will not be rendered. Some components, such as Button and Panel, manage the caption themselves and display it inside the component. This method will trigger a RepaintRequestEvent. A reimplementation should call the superclass implementation.
|
Gets the icon resource of the component. See setIcon for a detailed description of the icon.
See Also: setIcon |
Sets the icon of the component. An icon is an explanatory graphical label accompanying a user interface component, usually shown above, left of, or inside the component. Icon is closely related to caption (see setCaption) and is usually displayed horizontally before or after it, depending on the component and the containing layout. The image is loaded by the browser from a resource, typically a ThemeResource: # IComponent with an icon from a custom theme name = TextField("Name") name.setIcon(ThemeResource("icons/user.png")) layout.addComponent(name) # IComponent with an icon from another theme ('runo') ok = Button("OK") ok.setIcon(ThemeResource("../runo/icons/16/ok.png")) layout.addComponent(ok) The icon of a component is, by default, managed and displayed by the layout component or component container in which the component is placed. For example, the VerticalLayout component shows the icons left-aligned above the contained components, while the FormLayout component shows the icons on the left side of the vertically laid components, with the icons and their associated components left-aligned in their own columns. The CustomComponent does not manage the icon of its composition root, so if the root component has an icon, it will not be rendered. An icon will be rendered inside an HTML element that has the
This method will trigger a RepaintRequestEvent.
|
Gets the parent window of the component. If the component is not attached to a window through a component
containment hierarchy, The window can be either an application-level window or a sub-window. If the component is itself a window, it returns a reference to itself, not to its containing window (of a sub-window).
|
Gets the application object to which the component is attached. The method will return
See Also: attach |
Notifies the component that it is connected to an application. The caller of this method is setParent if the parent is itself already attached to the application. If not, the parent will call the attach for all its children when it is attached to the application. This method is always called before the component is painted for the first time. Reimplementing the class AttachExample(CustomComponent): def __init__(self): # ERROR: We can't access the application object yet. r = ClassResource("smiley.jpg", getApplication()) image = Embedded("Image:", r) setCompositionRoot(image) Adding a component to an application triggers calling the attach method for the component. Correspondingly,
removing a component from a container triggers calling the detach method. If the parent of an added component is
already connected to the application, the class AttachExample(CustomComponent): def __init__(self): pass def attach(self): super(AttachExample, self).attach() # must call # Now we know who ultimately owns us. r = ClassResource("smiley.jpg", self.getApplication()) image = Embedded("Image", r) self.setCompositionRoot(image) The attachment logic is implemented in AbstractComponent. See Also: getApplication |
Notifies the component that it is detached from the application. The getApplication and getWindow methods might return The caller of this method is setParent if the parent is in the application. When the parent is detached from the application it is its response to call detach for all the children and to detach itself from the terminal. |
Gets the locale of the component. If a component does not have a locale set, the locale of its parent is
returned, and so on. Eventually, if no parent has locale set, the locale
of the application is returned. If the application does not have a locale
set, it is determined by As the component must be attached before its locale can be acquired, using this method in the internationalization of component captions, etc. is generally not feasible. For such use case, we recommend using an otherwise acquired reference to the application locale.
|
The child components of the component must call this method when they need repainting. The call must be made even in the case in which the children sent the repaint request themselves. A repaint request is ignored if the component is invisible. This method is called automatically by AbstractComponent, which also provides a default implementation of it. As this is a somewhat internal feature, it is rarely necessary to reimplement this or call it explicitly.
|
Registers a new (generic) component event listener for the component: class Listening(CustomComponent, IListener): # Stored for determining the source of an event ok = None status = None # For displaying info about the event def __init__(self): layout = VerticalLayout() # Some miscellaneous component name = TextField("Say it all here") name.addListener(self) name.setImmediate(true) layout.addComponent(name) # Handle button clicks as generic events instead # of Button.ClickEvent events ok = new Button("OK") ok.addListener(self) layout.addComponent(ok) # For displaying information about an event status = new Label("") layout.addComponent(status) setCompositionRoot(layout) def componentEvent(event): # Act according to the source of the event if (event.getSource() == ok): getWindow().showNotification("Click!") status.setValue("Event from " + event.getSource().__class__.__name__ + ": " + event.__class__.__name__) listening = Listening() layout.addComponent(listening)
|
|
Removes a previously registered component event listener from this component.
See Also: addListener |
|
Home | Trees | Indices | Help |
|
---|
Generated by Epydoc 3.0.1 on Sat Jul 6 19:32:55 2013 | http://epydoc.sourceforge.net |