io.webfolder.cdp.command

Interface CSS

public interface CSS

This domain exposes CSS read/write operations All CSS objects (stylesheets, rules, and styles) have an associated id used in subsequent operations on the related object Each object type has a specific id structure, and those are not interchangeable between objects of different kinds CSS objects can be loaded using the get*ForNode() calls (which accept a DOM node id) A client can also keep track of stylesheets via the styleSheetAdded/styleSheetRemoved events and subsequently load the required stylesheet contents using the getStyleSheet[Text]() methods

Method Summary

Modifier and Type	Method and Description
CSSRule	addRule(String styleSheetId, String ruleText, SourceRange location) Inserts a new rule with the given ruleText in a stylesheet with given styleSheetId, at the position specified by location.
List<String>	collectClassNames(String styleSheetId) Returns all class names from specified stylesheet.
String	createStyleSheet(String frameId) Creates a new special "via-inspector" stylesheet in the frame with given frameId.
void	disable() Disables the CSS agent for the given page.
void	enable() Enables the CSS agent for the given page.
void	forcePseudoState(Integer nodeId, List<String> forcedPseudoClasses) Ensures that the given node will have specified pseudo-classes whenever its style is computed by the browser.
GetBackgroundColorsResult	getBackgroundColors(Integer nodeId)
List<CSSComputedStyleProperty>	getComputedStyleForNode(Integer nodeId) Returns the computed style for a DOM node identified by nodeId.
GetInlineStylesForNodeResult	getInlineStylesForNode(Integer nodeId) Returns the styles defined inline (explicitly in the "style" attribute and implicitly, using DOM attributes) for a DOM node identified by nodeId.
GetMatchedStylesForNodeResult	getMatchedStylesForNode(Integer nodeId) Returns requested styles for a DOM node identified by nodeId.
List<CSSMedia>	getMediaQueries() Returns all media queries parsed by the rendering engine.
List<PlatformFontUsage>	getPlatformFontsForNode(Integer nodeId) Requests information about platform fonts which we used to render child TextNodes in the given node.
String	getStyleSheetText(String styleSheetId) Returns the current textual content and the URL for a stylesheet.
void	setEffectivePropertyValueForNode(Integer nodeId, String propertyName, String value) Find a rule with the given active property for the given node and set the new value for this property
Value	setKeyframeKey(String styleSheetId, SourceRange range, String keyText) Modifies the keyframe rule key text.
CSSMedia	setMediaText(String styleSheetId, SourceRange range, String text) Modifies the rule selector.
SelectorList	setRuleSelector(String styleSheetId, SourceRange range, String selector) Modifies the rule selector.
String	setStyleSheetText(String styleSheetId, String text) Sets the new stylesheet text.
List<CSSStyle>	setStyleTexts(List<StyleDeclarationEdit> edits) Applies specified style edits one after another in the given order.
void	startRuleUsageTracking() Enables the selector recording.
List<RuleUsage>	stopRuleUsageTracking() The list of rules with an indication of whether these were used
List<RuleUsage>	takeCoverageDelta() Obtain list of rules that became used since last call to this method (or since start of coverage instrumentation)

Method Detail

enable

void enable()

Enables the CSS agent for the given page. Clients should not assume that the CSS agent has been enabled until the result of this command is received.

disable

void disable()

Disables the CSS agent for the given page.

getMatchedStylesForNode

GetMatchedStylesForNodeResult getMatchedStylesForNode(Integer nodeId)

Returns requested styles for a DOM node identified by nodeId.

Returns:

GetMatchedStylesForNodeResult

getInlineStylesForNode

GetInlineStylesForNodeResult getInlineStylesForNode(Integer nodeId)

Returns the styles defined inline (explicitly in the "style" attribute and implicitly, using DOM attributes) for a DOM node identified by nodeId.

Returns:

GetInlineStylesForNodeResult

getComputedStyleForNode

List<CSSComputedStyleProperty> getComputedStyleForNode(Integer nodeId)

Returns the computed style for a DOM node identified by nodeId.

Returns:

Computed style for the specified DOM node.

getPlatformFontsForNode

List<PlatformFontUsage> getPlatformFontsForNode(Integer nodeId)

Requests information about platform fonts which we used to render child TextNodes in the given node.

Returns:

Usage statistics for every employed platform font.

getStyleSheetText

String getStyleSheetText(String styleSheetId)

Returns the current textual content and the URL for a stylesheet.

Returns:

The stylesheet text.

collectClassNames

List<String> collectClassNames(String styleSheetId)

Returns all class names from specified stylesheet.

Returns:

Class name list.

setStyleSheetText

String setStyleSheetText(String styleSheetId,
                         String text)

Sets the new stylesheet text.

Returns:

URL of source map associated with script (if any).

setRuleSelector

SelectorList setRuleSelector(String styleSheetId,
                             SourceRange range,
                             String selector)

Modifies the rule selector.

Returns:

The resulting selector list after modification.

setKeyframeKey

Value setKeyframeKey(String styleSheetId,
                     SourceRange range,
                     String keyText)

Modifies the keyframe rule key text.

Returns:

The resulting key text after modification.

setStyleTexts

List<CSSStyle> setStyleTexts(List<StyleDeclarationEdit> edits)

Applies specified style edits one after another in the given order.

Returns:

The resulting styles after modification.

setMediaText

CSSMedia setMediaText(String styleSheetId,
                      SourceRange range,
                      String text)

Modifies the rule selector.

Returns:

The resulting CSS media rule after modification.

createStyleSheet

String createStyleSheet(String frameId)

Creates a new special "via-inspector" stylesheet in the frame with given frameId.

Parameters:

frameId - Identifier of the frame where "via-inspector" stylesheet should be created.

Returns:

Identifier of the created "via-inspector" stylesheet.

addRule

CSSRule addRule(String styleSheetId,
                String ruleText,
                SourceRange location)

Inserts a new rule with the given ruleText in a stylesheet with given styleSheetId, at the position specified by location.

Parameters:

styleSheetId - The css style sheet identifier where a new rule should be inserted.

ruleText - The text of a new rule.

location - Text position of a new rule in the target style sheet.

Returns:

The newly created rule.

forcePseudoState

void forcePseudoState(Integer nodeId,
                      List<String> forcedPseudoClasses)

Ensures that the given node will have specified pseudo-classes whenever its style is computed by the browser.

Parameters:

nodeId - The element id for which to force the pseudo state.

forcedPseudoClasses - Element pseudo classes to force when computing the element's style.

getMediaQueries

List<CSSMedia> getMediaQueries()

Returns all media queries parsed by the rendering engine.

setEffectivePropertyValueForNode

void setEffectivePropertyValueForNode(Integer nodeId,
                                      String propertyName,
                                      String value)

Find a rule with the given active property for the given node and set the new value for this property

Parameters:

nodeId - The element id for which to set property.

getBackgroundColors

GetBackgroundColorsResult getBackgroundColors(Integer nodeId)

Returns:

GetBackgroundColorsResult

startRuleUsageTracking

void startRuleUsageTracking()

Enables the selector recording.

takeCoverageDelta

List<RuleUsage> takeCoverageDelta()

Obtain list of rules that became used since last call to this method (or since start of coverage instrumentation)

stopRuleUsageTracking

List<RuleUsage> stopRuleUsageTracking()

The list of rules with an indication of whether these were used