org.zkoss.zul
Class Style

java.lang.Object
  org.zkoss.zk.ui.AbstractComponent
      org.zkoss.zul.Style

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, Component, Scope, ComponentCtrl, Style

public class Style
extends AbstractComponent
implements Style

The style component used to specify CSS styles for the owner desktop.

Note: a style component can appear anywhere in a ZUML page, but it affects all components in the same desktop.

Note: If isDynamic() is false, the HTML STYLE or LINK tag is generated to represent this component. Due to IE's limitation, there is no effect if the style component is added or removed dynamically and if isDynamic() is false.

If isDynamic() is true, this component can be added and removed dynamically and the rules will be attached and detached accordingly. Note: in this case, the link is generated when this component is initialized at the client, so the style will be loaded to the client after all components are initialized.

There are three formats when used in a ZUML page:

Method 1: Specify the URL of the CSS file

<style src="my.css"/>
 

Method 2: Specify the CSS directly

<style>
 .mycls {
  border: 1px outset #777;
 }
</style>
 

Method 3: Specify the CSS by use of the content property (setContent(java.lang.String)).

<style>
 <attribute name="content">
 .mycls {
  border: 1px outset #777;
 }
 </attribute>
</style>
 

Note: if the src and content properties are both set, the content property is ignored.

Author:

tomyeh

See Also:

Serialized Form

Nested Class Summary

protected class

Style.ExtraCtrl A utility class to implement AbstractComponent.getExtraCtrl().

Nested classes/interfaces inherited from class org.zkoss.zk.ui.AbstractComponent

AbstractComponent.Children

Field Summary

Fields inherited from class org.zkoss.zk.ui.AbstractComponent

_visible

Fields inherited from interface org.zkoss.zk.ui.Component

APPLICATION_SCOPE, COMPONENT_SCOPE, DESKTOP_SCOPE, PAGE_SCOPE, REQUEST_SCOPE, SESSION_SCOPE, SPACE_SCOPE

Constructor Summary

Style()

Style(java.lang.String src)

Method Summary

java.lang.String	getContent() Returns the content of the style element.
java.lang.String	getOuterAttrs() Returns the attributes for generating the HTML tags.
java.lang.String	getSrc() Returns the URI of an external style sheet.
boolean	isChildable() Not childable.
boolean	isDynamic() Returns whether to load an external Style Sheet dynamically.
protected java.lang.Object	newExtraCtrl() Used by AbstractComponent.getExtraCtrl() to create extra controls.
void	redraw(java.io.Writer out) Redraws this component.
void	setContent(java.lang.String content) Sets the content of the style element.
void	setDynamic(boolean dynamic) Sets whether to load an external Style Sheet dynamically.
void	setSrc(java.lang.String src) Sets the URI of an external style sheet.
boolean	setVisible(boolean visible) Not allowd.

Methods inherited from class org.zkoss.zk.ui.AbstractComponent

addAnnotation, addAnnotation, addEventHandler, addEventListener, addForward, addForward, addForward, addForward, addMoved, addSharedAnnotationMap, addSharedEventHandlerMap, appendAsapAttr, appendAsapAttr, appendChild, applyProperties, beforeChildAdded, beforeChildRemoved, beforeParentChanged, clone, containsVariable, detach, disableClientUpdate, equals, getAnnotatedProperties, getAnnotatedPropertiesBy, getAnnotation, getAnnotation, getAnnotations, getAnnotations, getAttribute, getAttribute, getAttributes, getAttributes, getChildren, getCommand, getDefinition, getDesktop, getEventHandler, getEventHandlerNames, getExtraCtrl, getFellow, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getMoldURI, getNamespace, getNextSibling, getPage, getParent, getPreviousSibling, getRoot, getSpaceOwner, getUuid, getVariable, hasFellow, insertBefore, invalidate, isAsapRequired, isInvalidated, isListenerAvailable, isVisible, newChildren, onChildAdded, onChildRemoved, onDrawNewChild, onPageAttached, onPageDetached, onWrongValue, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, response, sessionDidActivate, sessionWillPassivate, setAttribute, setAttribute, setComponentDefinition, setId, setMold, setPage, setPageBefore, setParent, setVariable, smartUpdate, smartUpdate, smartUpdate, smartUpdateDeferred, smartUpdateValues, toString, unsetVariable

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Style

public Style()

Style

public Style(java.lang.String src)

Parameters:

src - the URI of an external style sheet.

Method Detail

setDynamic

public void setDynamic(boolean dynamic)

Sets whether to load an external Style Sheet dynamically.

Default: false.

Specified by:

setDynamic in interface Style

Since:

3.0.4

See Also:

isDynamic()

isDynamic

public boolean isDynamic()

Returns whether to load an external Style Sheet dynamically. If false, a HTML STYLE or LINK tag is generated to represent the content or the src.

Due to IE's limitation, there is no effect if the style component is added or removed dynamically and if isDynamic() is false.

If isDynamic() is true, this component can be added and removed dynamically and the rules will be attached and detached accordingly. Note: in this case, the HTML LINK tag is generated when this component is initialized at the client, so the style will be loaded to the client after all components are initialized.

Default: false.

Specified by:

isDynamic in interface Style

Since:

3.0.4

getSrc

public java.lang.String getSrc()

Returns the URI of an external style sheet.

Default: null.

Specified by:

getSrc in interface Style

setSrc

public void setSrc(java.lang.String src)

Sets the URI of an external style sheet.

Calling this method implies setContent(null). In other words, the last invocation of setSrc(java.lang.String) overrides the previous setContent(java.lang.String), if any.

Specified by:

setSrc in interface Style

Parameters:

src - the URI of an external style sheet

See Also:

setContent(java.lang.String)

getContent

public java.lang.String getContent()

Returns the content of the style element. By content we mean the CSS rules that will be sent to the client.

Default: null.

Specified by:

getContent in interface Style

Since:

3.0.0

setContent

public void setContent(java.lang.String content)

Sets the content of the style element. By content we mean the CSS rules that will be sent to the client.

Calling this method implies setSrc(null). In other words, the last invocation of setContent(java.lang.String) overrides the previous setSrc(java.lang.String), if any.

Specified by:

setContent in interface Style

Since:

3.0.0

See Also:

setSrc(java.lang.String)

getOuterAttrs

public java.lang.String getOuterAttrs()

Returns the attributes for generating the HTML tags.

setVisible

public boolean setVisible(boolean visible)

Not allowd.

Specified by:

setVisible in interface Component

Overrides:

setVisible in class AbstractComponent

Returns:

the previous visibility

isChildable

public boolean isChildable()

Not childable.

Specified by:

isChildable in interface Component

Overrides:

isChildable in class AbstractComponent

newExtraCtrl

protected java.lang.Object newExtraCtrl()

Description copied from class: AbstractComponent

Used by AbstractComponent.getExtraCtrl() to create extra controls. It is used only by component developers.

Default: return null.

To provide extra controls, it is simpler to override this method instead of AbstractComponent.getExtraCtrl(). By use of AbstractComponent.newExtraCtrl(), you don't need to care of cloning and serialization.

Overrides:

newExtraCtrl in class AbstractComponent

redraw

public void redraw(java.io.Writer out)
            throws java.io.IOException

Description copied from class: AbstractComponent

Redraws this component. This method implements the mold mechanism.

1. It first invokes AbstractComponent.getMoldURI() to retrieve the mold to redraw. The mold is either an URI (String) or a ComponentRenderer instance.
2. If URI, it invokes Execution.include(java.io.Writer, java.lang.String, java.util.Map, int) to generate the output.
3. If a ComponentRenderer instance, ComponentRenderer.render(org.zkoss.zk.ui.Component, java.io.Writer) is called to generate the output.

Specified by:

redraw in interface Component

Overrides:

redraw in class AbstractComponent

Throws:

java.io.IOException